progit2

progit2 copied to clipboard

hello, does someone know the most appropriate way to assemble all these `.asc' file-snippets into one big file for upload on git-scm.com ? greetings, kalle

We assemble and compile the files to their target format with asciidoctor. Unfortunately, there's no pure text target for asciidoctor as described in https://github.com/git/git-scm.com/issues/1189.

Concerning the idea of not having any image in the book, what's your motive? Some images are really required to understand how the graphs of revisions or objects are laid out. The accompanying description in text is really lacking details to convey the meaning.

Otherwise, assembling the files by script is quite simple, it's just a matter of recursively expanding the include macros from progit.asc. For instance in ruby, you can have a look at

https://github.com/git/git-scm.com/blob/87e50848ec8870e65fdcba4714cda4f159fd7c37/lib/tasks/book2.rake#L6-L21

Am 04.04.2018 um 20:49 schrieb Jean-Noël Avila:

We assemble and compile the files to their target format with asciidoctor. Unfortunately, there's no pure text target for asciidoctor as described in https://github.com/git/git-scm.com/issues/1189.

But as you said, 'asc'-format is ok for reading.

Concerning the idea of not having any image in the book, what's your motive? Some images are really required to understand how the graphs of revisions or objects are laid out. The accompanying description in text is really lacking details to convey the meaning.

My constraint was, that in order to be more universal, documentation should not require to use GUIs as X, as most documentation does. In the "user-manual.txt", whose existence I pointed out at https://github.com/git/git-scm.com/issues/1188 , the shemes are expressed as ascii-art. I can't tell if is difficult to form ascii-art (if there is a program for this), but if the effort is not so big I think this would be the way to go.

Otherwise, assembling the files by script is quite simple, it's just a matter of recursively expanding the include macros from progit.asc. For instance in ruby, you can have a look at

https://github.com/git/git-scm.com/blob/87e50848ec8870e65fdcba4714cda4f159fd7c37/lib/tasks/book2.rake#L6-L21

I'm a newbie in this things and maybe therefore don't understand what you mean by "include macros". I searched some "progit.asc"-files but when using search didn't find any hits to "include".

greetings, kalle