Re: [PATCH 5/9] docs: add documentation for loose objects
- From
Patrick Steinhardt <ps@pks.im>
- Date
- Sep 24, 2025, 07:55 UTC
- Message-ID
- <aNOkAYsqavZjnYSO@pks.im>
- In-Reply-To
- <xmqqms6q45nl.fsf@gitster.g>
On Fri, Sep 19, 2025 at 12:13:34PM -0700, Junio C Hamano wrote:
Show 50 quoted lines
> Junio C Hamano <gitster@pobox.com> writes:
> > "brian m. carlson" <sandals@crustytoothpaste.net> writes:
> >
> >> We currently have no documentation for how loose objects are stored.
> >> Let's add some here so its easy for people to understand how they
> >> work.
> >>
> >> Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
> >> ---
> >> Documentation/gitformat-loose.adoc | 49 ++++++++++++++++++++++++++++++
> >> 1 file changed, 49 insertions(+)
> >> create mode 100644 Documentation/gitformat-loose.adoc
> >
> > Fails a build, unfortunately.
> >
> > ...
> > LINT DOCSTYLE includes/cmd-config-section-rest.adoc
> > GEN lint-docs-manpages
> > LINT DOCSTYLE includes/cmd-config-section-all.adoc
> > tmp-meson-diff/meson.adoc tmp-meson-diff/actual.adoc differ: char 3297, line 176
> > Meson man pages differ from actual man pages:
> > --- tmp-meson-diff/meson.adoc 2025-09-19 12:04:55.145229743 -0700
> > +++ tmp-meson-diff/actual.adoc 2025-09-19 12:04:55.149229734 -0700
> > @@ -173,6 +173,7 @@
> > gitformat-chunk.adoc
> > gitformat-commit-graph.adoc
> > gitformat-index.adoc
> > +gitformat-loose.adoc
> > gitformat-pack.adoc
> > gitformat-signature.adoc
> > gitglossary.adoc
> >
> > Thanks.
>
> Probably this should be sufficient? Not tested (yet).
>
>
>
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index 4404c623f0..93fa3dee8b 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -171,6 +171,7 @@ manpages = {
> 'gitformat-chunk.adoc' : 5,
> 'gitformat-commit-graph.adoc' : 5,
> 'gitformat-index.adoc' : 5,
> + 'gitformat-loose.adoc' : 5,
> 'gitformat-pack.adoc' : 5,
> 'gitformat-signature.adoc' : 5,
> 'githooks.adoc' : 5,Yup, this one looks correct. But in fact, we also need a similar change to our Makefile.
Patrick
diff --git a/Documentation/Makefile b/Documentation/Makefile index 6fb83d0c6e..e1d38fbfe6 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -34,6 +34,7 @@ MAN5_TXT += gitformat-bundle.adoc MAN5_TXT += gitformat-chunk.adoc MAN5_TXT += gitformat-commit-graph.adoc MAN5_TXT += gitformat-index.adoc +MAN5_TXT += gitformat-loose.adoc MAN5_TXT += gitformat-pack.adoc MAN5_TXT += gitformat-signature.adoc MAN5_TXT += githooks.adoc diff --git a/Documentation/meson.build b/Documentation/meson.build index 41f43e0336..64f70ac724 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -172,6 +172,7 @@ manpages = { 'gitformat-chunk.adoc' : 5, 'gitformat-commit-graph.adoc' : 5, 'gitformat-index.adoc' : 5, + 'gitformat-loose.adoc' : 5, 'gitformat-pack.adoc' : 5, 'gitformat-signature.adoc' : 5, 'githooks.adoc' : 5,