Thread (80 messages) 80 messages, 4 authors, 2022-11-21

[PATCH 0/2] git(1) doc + "git help": split-out user & git format docs

flat view
STALE1416d

From: Ævar Arnfjörð Bjarmason <hidden>
Date: 2021-10-15 02:05:58

This series goes on top of tz/doc-link-to-bundle-format-fix (and my
newly-landed ab/help-config-vars) and creates new "User-facing file
formats" and "Git file and wire formats" sections in the main git
manual page.

My main motivation here was to make the Documentation/technical/* docs
more discoverable and accessible.

2/2 moves over the "bundle-format.txt" into a new gitformat-bundle(5)
manual page, allowing git-bundle(1) to link to it as another man page
(no more links from man pages to generated HTML!).

I've got pending patches to migrate all of the rest of the relevant
"format" documentation in Documentation/technical/*, but setting up
the infrastructure for that first should be easier for reviewers to
consider.

Ævar Arnfjörð Bjarmason (2):
  git(1) docs: split "User-facing file formats" off from "Guides"
  git(1) docs: create a "Git file and wire formats" section

 Documentation/Makefile                        |  4 +-
 Documentation/git-bundle.txt                  | 12 +++--
 Documentation/git-help.txt                    | 11 +++--
 Documentation/git.txt                         | 15 +++++++
 ...bundle-format.txt => gitformat-bundle.txt} | 44 ++++++++++++++++---
 Documentation/lint-man-section-order.perl     |  3 ++
 Makefile                                      |  1 +
 builtin/help.c                                | 16 +++++++
 command-list.txt                              | 21 ++++++---
 help.c                                        | 22 ++++++++++
 help.h                                        |  2 +
 t/t0012-help.sh                               | 16 ++++++-
 12 files changed, 145 insertions(+), 22 deletions(-)
 rename Documentation/{technical/bundle-format.txt => gitformat-bundle.txt} (78%)

-- 
2.33.1.1338.g20da966911a
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help