[PATCH v6 0/9] docs: create & use "(user|developer) interfaces" categories
- From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- Date
- Jul 28, 2022, 16:46 UTC
- Message-ID
- <cover-v6-0.9-00000000000-20220728T164243Z-avarab@gmail.com>
- In-Reply-To
- <cover-v5-0.9-00000000000-20220721T160721Z-avarab@gmail.com>
See the v5 for a general overview: https://lore.kernel.org/git/cover-v5-0.9-00000000000-20220721T160721Z-avarab@gmail.com/
This trivial v6 fixes a grammar error in a commit message pointed-out by Eric Sunshine, thanks Eric!
Ævar Arnfjörð Bjarmason (9): help.c: BUG() out if "help --guides" can't remove "git" prefixes git help doc: use "<doc>" instead of "<guide>" git docs: add a category for user-facing file, repo and command UX git docs: add a category for file formats, protocols and interfaces docs: move commit-graph format docs to man section 5 docs: move protocol-related docs to man section 5 docs: move pack format docs to man section 5 docs: move http-protocol docs to man section 5 docs: move multi-pack-index docs to man section 5
Documentation/Makefile | 26 +++++-----
Documentation/config/lsrefs.txt | 2 +-
Documentation/config/pack.txt | 2 +-
Documentation/config/protocol.txt | 2 +-
Documentation/git-bundle.txt | 13 +++--
Documentation/git-commit-graph.txt | 5 ++
Documentation/git-help.txt | 27 ++++++++--
Documentation/git-multi-pack-index.txt | 6 +--
Documentation/git-upload-pack.txt | 7 ++-
Documentation/git.txt | 17 +++++++
...bundle-format.txt => gitformat-bundle.txt} | 44 ++++++++++++++---
.../chunk-format.txt => gitformat-chunk.txt} | 29 ++++++++---
...-format.txt => gitformat-commit-graph.txt} | 49 +++++++++++++------
.../index-format.txt => gitformat-index.txt} | 22 ++++++++-
...dex.txt => gitformat-multi-pack-index.txt} | 20 +++++++-
...uft-packs.txt => gitformat-pack-cruft.txt} | 22 ++++++++-
.../pack-format.txt => gitformat-pack.txt} | 39 +++++++++++++--
...ure-format.txt => gitformat-signature.txt} | 21 ++++++--
...ities.txt => gitprotocol-capabilities.txt} | 28 ++++++++---
...ocol-common.txt => gitprotocol-common.txt} | 23 ++++++++-
...http-protocol.txt => gitprotocol-http.txt} | 35 ++++++++++---
...pack-protocol.txt => gitprotocol-pack.txt} | 28 ++++++++---
.../protocol-v2.txt => gitprotocol-v2.txt} | 27 +++++++---
.../howto/recover-corrupted-object-harder.txt | 2 +-
Documentation/lint-man-section-order.perl | 3 ++
Documentation/technical/api-simple-ipc.txt | 2 +-
.../technical/hash-function-transition.txt | 2 +-
.../long-running-process-protocol.txt | 2 +-
Documentation/technical/packfile-uri.txt | 2 +-
Documentation/technical/partial-clone.txt | 2 +-
Documentation/user-manual.txt | 2 +-
Makefile | 1 +
builtin/help.c | 20 +++++++-
cache.h | 3 +-
command-list.txt | 38 +++++++++++---
help.c | 34 ++++++++++++-
help.h | 2 +
pack-revindex.h | 2 +-
refspec.h | 2 +-
t/t0012-help.sh | 14 +++++-
t/t5551-http-fetch-smart.sh | 4 +-
41 files changed, 508 insertions(+), 123 deletions(-)
rename Documentation/{technical/bundle-format.txt => gitformat-bundle.txt} (79%)
rename Documentation/{technical/chunk-format.txt => gitformat-chunk.txt} (89%)
rename Documentation/{technical/commit-graph-format.txt => gitformat-commit-graph.txt} (87%)
rename Documentation/{technical/index-format.txt => gitformat-index.txt} (98%)
rename Documentation/{technical/multi-pack-index.txt => gitformat-multi-pack-index.txt} (94%)
rename Documentation/{technical/cruft-packs.txt => gitformat-pack-cruft.txt} (96%)
rename Documentation/{technical/pack-format.txt => gitformat-pack.txt} (95%)
rename Documentation/{technical/signature-format.txt => gitformat-signature.txt} (96%)
rename Documentation/{technical/protocol-capabilities.txt => gitprotocol-capabilities.txt} (96%)
rename Documentation/{technical/protocol-common.txt => gitprotocol-common.txt} (89%)
rename Documentation/{technical/http-protocol.txt => gitprotocol-http.txt} (97%)
rename Documentation/{technical/pack-protocol.txt => gitprotocol-pack.txt} (98%)
rename Documentation/{technical/protocol-v2.txt => gitprotocol-v2.txt} (97%)Range-diff against v5:
1: b0bb29bb131 = 1: f3588319057 help.c: BUG() out if "help --guides" can't remove "git" prefixes
2: 2ec00f81552 = 2: 80322d44ea5 git help doc: use "<doc>" instead of "<guide>"
3: 31be7d01c50 = 3: 0d22eb645bd git docs: add a category for user-facing file, repo and command UX
4: a7310898866 ! 4: c25f8ec9bf5 git docs: add a category for file formats, protocols and interfaces
@@ Commit message
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,
+ to it. This complements the newly added and adjacent "Repository,
command and file interfaces" section.
This makes the technical documentation more accessible and
5: 62f9020a72d = 5: 466dbd2a993 docs: move commit-graph format docs to man section 5
6: 019ec8cf73c = 6: 9a551b2d53a docs: move protocol-related docs to man section 5
7: 5b081e6637a = 7: 92be18b95d9 docs: move pack format docs to man section 5
8: 8f8214addfd = 8: a8a883ebf85 docs: move http-protocol docs to man section 5
9: 19601ac36a2 = 9: ecfda8c6770 docs: move multi-pack-index docs to man section 5-- 2.37.1.1197.g7ed548b7807