Re: [PATCH v5 4/9] git docs: add a category for file formats, protocols and interfaces
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Jul 21, 2022, 17:31 UTC
- Message-ID
- <CAPig+cQ99HD0d9wDS1=ESsDgucu_Dqk5YJGSYB9USUZ1odMP4Q@mail.gmail.com>
- In-Reply-To
- <patch-v5-4.9-a7310898866-20220721T160721Z-avarab@gmail.com>
/On Thu, Jul 21, 2022 at 12:14 PM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
Show 5 quoted lines
> Create a new "File formats, protocols and other developer interfaces" > section in the main "git help git" manual page and start moving the > documentation that now lives in "Documentation/technical/*.git" over > to it. This compliments the newly added and adjacent "Repository, > command and file interfaces" section.
nit: s/compliments/complements/
Show 18 quoted lines
> This makes the technical documentation more accessible and > discoverable. Before this we wouldn't install it by default, and had > no ability to build man page versions of them. The links to them from > our existing documentation link to the generated HTML version of these > docs. > > So let's start moving those over, starting with just the > "bundle-format.txt" documentation added in 7378ec90e1c (doc: describe > Git bundle format, 2020-02-07). We'll now have a new > gitformat-bundle(5) man page. Subsequent commits will move more git > internal format documentation over. > > Unfortunately the syntax of the current Documentation/technical/*.txt > is not the same (when it comes to section headings etc.) as our > Documentation/*.txt documentation, so change the relevant bits of > syntax as we're moving this over. > > Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>