git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: Re: [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order
Date: Thu, 10 Mar 2011 08:50:07 +0100	[thread overview]
Message-ID: <4D7882AF.4010705@drmicha.warpmail.net> (raw)
In-Reply-To: <7vbp1j985v.fsf@alter.siamese.dyndns.org>

Junio C Hamano venit, vidit, dixit 10.03.2011 00:38:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
>> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
>> index 48c1715..6ae57dc 100644
>> --- a/Documentation/git-log.txt
>> +++ b/Documentation/git-log.txt
>> @@ -77,12 +77,12 @@ Common diff options
>>  ~~~~~~~~~~~~~~~~~~~
>>  
>>  :git-log: 1
>> -include::diff-options.txt[]
>> -
>>  include::rev-list-options.txt[]
>>  
>>  include::pretty-formats.txt[]
>>  
>> +include::diff-options.txt[]
>> +
>>  include::diff-generate-patch.txt[]
> 
> This is wrong.  The title "Common diff options", telling the AsciiDoc that
> we are formatting for git-log manual page with ":git-log: 1" and inclusion
> of diff-options.txt form a single group.  With your patch, the "Common
> diff options" section will become ampty and makes AsciiDoc barf.
> 
> You would need _at least_ something like the attached patch on top, which
> for now I'll squash in.

Didn't I say "squashable series"? ;)

Seriously, I'm sorry for this blunder. I usually build Doc before
submitting Doc patches (and here more careful reading should have sufficed).

>  Documentation/git-log.txt |    8 ++++----
>  1 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 6ae57dc..c43aa43 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -73,14 +73,14 @@ produced by --stat etc.
>  	to be prefixed with "\-- " to separate them from options or
>  	refnames.
>  
> -Common diff options
> -~~~~~~~~~~~~~~~~~~~
> -
> -:git-log: 1
>  include::rev-list-options.txt[]
>  
>  include::pretty-formats.txt[]
>  
> +Common diff options
> +-------------------
> +
> +:git-log: 1
>  include::diff-options.txt[]
>  
>  include::diff-generate-patch.txt[]

Thanks, that's what I meant, and I also meant to mark 3/3 as PATCH/RFC
because it's a larger change in the Doc for a main command.

Michael

  reply	other threads:[~2011-03-10  7:53 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-03-07 19:17 --max-count useless with git-rev-list's --reverse Ævar Arnfjörð Bjarmason
2011-03-07 19:40 ` Shawn Pearce
2011-03-08  7:35   ` Jay Soffian
2011-03-08  8:34     ` Michael J Gruber
2011-03-08  8:30 ` Michael J Gruber
2011-03-08  8:31   ` [PATCH 1/3] rev-list-options.txt: typo fix Michael J Gruber
2011-03-08  8:31     ` [PATCH 2/3] git-log.txt,rev-list-options.txt: -n/--max-count is commit limiting Michael J Gruber
2011-03-08 19:59       ` Junio C Hamano
2011-03-09  7:11         ` Michael J Gruber
2011-03-08  8:31     ` [PATCH 3/3] git-log.txt,rev-list-options.txt: put option blocks in proper order Michael J Gruber
2011-03-09 23:38       ` Junio C Hamano
2011-03-10  7:50         ` Michael J Gruber [this message]
2011-03-08 19:56     ` [PATCH 1/3] rev-list-options.txt: typo fix Junio C Hamano
2011-03-09  7:07       ` Michael J Gruber

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4D7882AF.4010705@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).