| Message ID | 20211001113725.13354-2-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | blame: documentation update | expand |
Bagas Sanjaya <bagasdotme@gmail.com> writes: > While there is descriptions for porcelain and incremental output > formats, the default format isn't described. Describe that format for > the sake of completeness. > > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > Documentation/git-blame.txt | 13 +++++++++++++ > 1 file changed, 13 insertions(+) > > diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt > index 3bf5d5d8b4..683f8ab0b0 100644 > --- a/Documentation/git-blame.txt > +++ b/Documentation/git-blame.txt > @@ -93,6 +93,19 @@ include::blame-options.txt[] > is used for a caret to mark the boundary commit. > > > +THE DEFAULT FORMAT > +------------------ > + > +When neither `--porcelain` nor `--incremental` option is specified, > +`git blame` will output annotation for each line with: > + > +- abbreviated object name for the commit the line came from; > +- author ident (by default author name and date unless `-s` or `-e` is > +specified); and It probably would become easier to read with a comma before "unless". Other than that (and the downcasing of Describe in the title), looks good to me. Thanks. > +- line number > + > +before the line contents. > + > THE PORCELAIN FORMAT > --------------------
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 3bf5d5d8b4..683f8ab0b0 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -93,6 +93,19 @@ include::blame-options.txt[] is used for a caret to mark the boundary commit. +THE DEFAULT FORMAT +------------------ + +When neither `--porcelain` nor `--incremental` option is specified, +`git blame` will output annotation for each line with: + +- abbreviated object name for the commit the line came from; +- author ident (by default author name and date unless `-s` or `-e` is +specified); and +- line number + +before the line contents. + THE PORCELAIN FORMAT --------------------
While there is descriptions for porcelain and incremental output formats, the default format isn't described. Describe that format for the sake of completeness. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/git-blame.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+)