# Where man git-format-patch sends me? 5 messages from 2007-11-01 to 2007-11-02. Participants: Sergei Organov, Johannes Schindelin, Wincent Colaiuta. Thread: https://gitlist.dev/t/10562 ## Sergei Organov, 2007-11-01 13:58 Subject: Where man git-format-patch sends me? Message-ID: <87lk9i2hkc.fsf@osv.gnss.ru> URL: https://gitlist.dev/e/87lk9i2hkc.fsf%40osv.gnss.ru ``` $ man git-format-patch [...] OPTIONS -p Generate patch (see section on generating patches) -u Synonym for "-p". [...] $ 1. Saying "-p generates patch" suggests that without -p git-format-patch will generate something else. It's rather confusing. 2. Where is this "section on generating patches"? I thought it could be in man git-diff, but it is not. -- Sergei. ``` ## Johannes Schindelin, 2007-11-01 14:38 Subject: Re: Where man git-format-patch sends me? Message-ID: URL: https://gitlist.dev/e/Pine.LNX.4.64.0711011437440.4362%40racer.site In-Reply-To: <87lk9i2hkc.fsf@osv.gnss.ru> ``` Hi, On Thu, 1 Nov 2007, Sergei Organov wrote: > $ man git-format-patch > [...] > OPTIONS > -p Generate patch (see section on generating patches) > > -u Synonym for "-p". As you can easily see from Documentation/git-format-patch.txt, this part is generated from the file Documentation/diff-options.txt. Hth, Dscho ``` ## Sergei Organov, 2007-11-01 15:47 Subject: Re: Where man git-format-patch sends me? Message-ID: <877il22cip.fsf@osv.gnss.ru> URL: https://gitlist.dev/e/877il22cip.fsf%40osv.gnss.ru In-Reply-To: ``` Johannes Schindelin writes: > Hi, > > On Thu, 1 Nov 2007, Sergei Organov wrote: > >> $ man git-format-patch >> [...] >> OPTIONS >> -p Generate patch (see section on generating patches) >> >> -u Synonym for "-p". > > As you can easily see from Documentation/git-format-patch.txt, this part > is generated from the file Documentation/diff-options.txt. Sorry, I did saw that, but it doesn't change anything. 1. As a user reading man git-format-patch, where do I find this "section on generating patches"? In another man-page? In the html documentation? On the moon? 2. I can't find "section on generating patches" in the man git-diff either, and I did say this in the part of my original message you've snipped. So the main question remains: could you please point me to the exact place in 'Documentation/' directory where this "section on generating patches" resides? -- Sergei. ``` ## Wincent Colaiuta, 2007-11-02 10:03 Subject: Re: Where man git-format-patch sends me? Message-ID: <2A9EA819-C27A-4538-A9ED-B5281D137B94@wincent.com> URL: https://gitlist.dev/e/2A9EA819-C27A-4538-A9ED-B5281D137B94%40wincent.com In-Reply-To: <877il22cip.fsf@osv.gnss.ru> ``` El 1/11/2007, a las 16:47, Sergei Organov escribió: > Johannes Schindelin writes: > >> Hi, >> >> On Thu, 1 Nov 2007, Sergei Organov wrote: >> >>> $ man git-format-patch >>> [...] >>> OPTIONS >>> -p Generate patch (see section on generating patches) >>> >>> -u Synonym for "-p". >> >> As you can easily see from Documentation/git-format-patch.txt, this >> part >> is generated from the file Documentation/diff-options.txt. > > Sorry, I did saw that, but it doesn't change anything. > > 1. As a user reading man git-format-patch, where do I find this > "section > on generating patches"? In another man-page? In the html > documentation? On the moon? > > 2. I can't find "section on generating patches" in the man git-diff > either, and I did say this in the part of my original message you've > snipped. > > So the main question remains: could you please point me to the exact > place in 'Documentation/' directory where this "section on generating > patches" resides? I believe the section in question is in Documentation/diff-format.txt But you've basically found a documentation bug. Someone invoking "man git-format-patch" shouldn't be expected to have to grep the source tree in order to find out where the referenced documentation is. Especially given that he/she may not even have the source. Cheers, Wincent ``` ## Sergei Organov, 2007-11-02 11:25 Subject: Re: Where man git-format-patch sends me? Message-ID: <87odec28jj.fsf@osv.gnss.ru> URL: https://gitlist.dev/e/87odec28jj.fsf%40osv.gnss.ru In-Reply-To: <2A9EA819-C27A-4538-A9ED-B5281D137B94@wincent.com> ``` Wincent Colaiuta writes: > El 1/11/2007, a las 16:47, Sergei Organov escribió: > >> Johannes Schindelin writes: >> >>> Hi, >>> >>> On Thu, 1 Nov 2007, Sergei Organov wrote: >>> >>>> $ man git-format-patch >>>> [...] >>>> OPTIONS >>>> -p Generate patch (see section on generating patches) >>>> >>>> -u Synonym for "-p". >>> >>> As you can easily see from Documentation/git-format-patch.txt, this >>> part >>> is generated from the file Documentation/diff-options.txt. >> >> Sorry, I did saw that, but it doesn't change anything. >> >> 1. As a user reading man git-format-patch, where do I find this >> "section >> on generating patches"? In another man-page? In the html >> documentation? On the moon? >> >> 2. I can't find "section on generating patches" in the man git-diff >> either, and I did say this in the part of my original message you've >> snipped. >> >> So the main question remains: could you please point me to the exact >> place in 'Documentation/' directory where this "section on generating >> patches" resides? > > I believe the section in question is in Documentation/diff-format.txt Ah, thank you! Now, diff-format.txt is included by git-diff-index/git-diff-files/git-diff-tree, but not by git-diff and git-format-patch. Do you think it is the right thing for the latter two to include diff-format as well? -- Sergei. ```