Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
root = true

[*]
indent_style = tab
trim_trailing_whitespace = true
indent_size = 4
end_of_line = LF

[*.md]
indent_style = space

[README]
indent_style = space
88 changes: 62 additions & 26 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -191,72 +191,81 @@ In addition to allowing all the normal `git log` options except for
`--notes`, `--format` and `--pretty` (`--oneline` is allowed and
silently ignored), the following additional options may be utilized:

* `--seconds`
* `--seconds`
include seconds in the time (i.e. HH:MM:SS instead of just HH:MM)

* `--minutes`
include minutes but not seconds in the time (i.e. HH:MM not HH:MM:SS)
* `--minutes`
include minutes but not seconds in the time (i.e. HH:MM not HH:MM:SS)
This is the default

* `--no-times`
* `--no-times`
omit the time field entirely

* `--two-initials`
only show at most two initials instead of the usual three
* `--two-initials`
only show at most two initials instead of the usual three
This is the default if `--initials=author,committer` or
`--initials=committer,author` is used.

* `--three-initials`
show at most three initials
* `--three-initials`
show at most three initials
This is the default unless `--initials=author,committer` or
`--initials=committer,author` is used.

* `--no-initials`
* `--no-initials`
omit the initials field entirely

* `--commit-message`
* `--commit-message`
when using `--walk-reflogs` show commit message not reflog message

* `--author-date`
force use of author dates and times
* `--author-date`
force use of author dates and times
The default is to use committer dates and times unless
`--author-date-order` is in effect. This option forces author
dates and times to always be used and overrides `--committer-date`.

* `--committer-date`
force use of committer dates and times
* `--committer-date`
force use of committer dates and times
The default is to use committer dates and times if `--date-order` or
`--topo-order` is in effect or `--author-date-order` is NOT in effect.
This option forces committer dates and times to always be used and
overrides a previous `--author-date` option.

* `--initials=author`
show author initials
* `--initials=author`
show author initials
This is the default behavior

* `--initials=committer`
* `--initials=committer`
show committer initials instead of author initials

* `--initials=author,committer`
show author and commiter initials separated by a `/`
* `--initials=author,committer`
show author and commiter initials separated by a `/`
This changes the initials width default from three to two.

* `--initials=committer,author`
show commiter and author initials separated by a `/`
* `--initials=committer,author`
show commiter and author initials separated by a `/`
This changes the initials width default from three to two.

* `--time-zone=zone`
set the TZ environment variable to `zone`
* `--time-zone=zone`
set the TZ environment variable to `zone`
This is an alterative to setting TZ before running `git log-compact`
and will affect the time zone dates and times are displayed in.

* `--weekday`
* `--weekday`
show the weekday with the date

* `--no-weekday`
do not show the weekday with the date
* `--no-weekday`
do not show the weekday with the date
This is the default behavior

* `--pager=PAGER`
pass output through PAGER
Default is the output of `git var GIT_PAGER`.

* `--default-colors`
use the default colors on ANSI terminals.
This speeds things up because it means git-log-compact doesn't have
to run `git config --get-color` several times.

In addition to the above options, color output is controlled as normal
for `git log` with the addition of `color.log-compact.date`,
`color.log-compact.time` and `color.log-compact.initials` config options
Expand All @@ -266,3 +275,30 @@ Furthermore, default options may be set in the `log-compact.defaults`
config value and they will be treated as though they appeared at
the very beginning of the `git log-compact` command line option list
(e.g. `git config log-compact.defaults "--abbrev=8 --seconds"`).

If the `GIT_LOG_COMPACT_OPTIONS` environment variable is set, its contents
will be used as default options **instead of** the contents of the
`log-compact.defaults` variable.


Making it run faster
--------------------

The things that take git-log-compact the longest are reading configuration.
Therefore, for maximum speed, specify all the configuration in
`GIT_LOG_COMPACT_OPTIONS`. For example (in `bash`):

export GIT_LOG_COMPACT_OPTIONS="--decorate --color=always --pager=less --default-colors"


Contributors
------------

* Kyle J. McKay <mackyle@gmail.com>
* Christopher White <cxwembedded@gmail.com>


License
-------

GPL v2, <https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>
Loading