| Message ID | a1b9bd9af90df88b7ce14de60a9626d2a1f2d3e8.1654623814.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | accf237ab5fed31ee5ece22f503b33acad0d5e31 |
| Headers | show |
| Series | bitmap-format.txt: fix some formatting issues and include checksum info | expand |
"Abhradeep Chakraborty via GitGitGadget" <gitgitgadget@gmail.com> writes: > From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com> > > Documentation/Makefile does not include bitmap-format.txt to generate > a html page using asciidoc. > > Teach Documentation/Makefile to also generate a html page for > Documentation/technical/bitmap-format.txt file. > > Signed-off-by: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com> > --- > Documentation/Makefile | 1 + > 1 file changed, 1 insertion(+) The change itself is obviously correct (assuming that it is worth passing the document to AsciiDoc, instead of reading it in text, that is). > diff --git a/Documentation/Makefile b/Documentation/Makefile > index d3f043f50d2..8d405a14330 100644 > --- a/Documentation/Makefile > +++ b/Documentation/Makefile > @@ -94,6 +94,7 @@ TECH_DOCS += MyFirstContribution > TECH_DOCS += MyFirstObjectWalk > TECH_DOCS += SubmittingPatches > TECH_DOCS += ToolsForGit > +TECH_DOCS += technical/bitmap-format > TECH_DOCS += technical/bundle-format > TECH_DOCS += technical/hash-function-transition > TECH_DOCS += technical/http-protocol Is bitmap-format the only one that is not fed to AsciiDoc, by the way? Are there other 'text-only' document that is worth converting to AsciiDoc? It is outside the scope of this series, of course, to actually adjusting them, but since you are already doing the homework, I thought you might already know the answer, which may become a source of inspriation for others to find something to work on. Thanks.
On Tue, Jun 07, 2022 at 05:43:32PM +0000, Abhradeep Chakraborty via GitGitGadget wrote: > From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com> > > Documentation/Makefile does not include bitmap-format.txt to generate > a html page using asciidoc. > > Teach Documentation/Makefile to also generate a html page for > Documentation/technical/bitmap-format.txt file. I am glad to see us finally getting around to this ;). I proposed this back in: https://lore.kernel.org/git/b0bb2e8051f19ec47140fda6500e092e37c6bea8.1624314293.git.me@ttaylorr.com/ but I dropped it from later versions of that series, due in large part to some of the formatting issues that your series here fixes. Thanks, Taylor
Junio C Hamano <gitster@pobox.com> wrote: > Is bitmap-format the only one that is not fed to AsciiDoc, by the > way? Are there other 'text-only' document that is worth converting > to AsciiDoc? > > It is outside the scope of this series, of course, to actually > adjusting them, but since you are already doing the homework, I > thought you might already know the answer, which may become a source > of inspriation for others to find something to work on. No, bitmap-format is not the only one. There are more text-only files. Some of them which I found till now are - technical/chunk-format.txt, technical/commit-graph.txt etc. There are more but I don't know if they actually need html conversion. These two texts (which I mentioned) is I think worth having html files. I was thinking of adding those in my commit but later I thought it would divert the patch series. Thanks :)
diff --git a/Documentation/Makefile b/Documentation/Makefile index d3f043f50d2..8d405a14330 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -94,6 +94,7 @@ TECH_DOCS += MyFirstContribution TECH_DOCS += MyFirstObjectWalk TECH_DOCS += SubmittingPatches TECH_DOCS += ToolsForGit +TECH_DOCS += technical/bitmap-format TECH_DOCS += technical/bundle-format TECH_DOCS += technical/hash-function-transition TECH_DOCS += technical/http-protocol