| Message ID | 20210514121435.504423-4-felipe.contreras@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | doc: asciidoctor: direct man page creation and fixes | expand |
On Fri, 14 May 2021 at 14:14, Felipe Contreras <felipe.contreras@gmail.com> wrote: > > Asciidoc automatically generates a date with format '%Y-%m-%d', while > asciidoctor '%F'. Is that really the format Asciidoc uses? Not that it matters much for the purposes of this patch. > I personally prefer the latter, so only modify it for diff purposes. I agree completely. > Fixes tons of these: > > -Git omitted 01/01/1970 GIT-ADD(1) > +Git omitted 1970-01-01 GIT-ADD(1) > then > - echo USE_ASCIIDOCTOR=YesPlease > + echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_EXTRA='-adocdate="01/01/1970"' > fi Nice. If you introduce a separate Makefile flag and incorporate Peff's patch to doc-diff "asciidoctor" and "asciidoctor-direct", you'd need to duplicate this a bit, or maybe just emit the ASCIIDOC_EXTRA outside of the whole if chain. You could follow up with the patch below. If you'd rather keep it out of your series to avoid it ballooning, fine. I can repost it later, once the dust has settled. Don't let it hold up your work. -- >8 -- Subject: [PATCH] doc-diff: drop --cut-footer switch Now that our doc-diff convinces Asciidoctor to insert the exact same formatted dummy date as AsciiDoc, we can drop the --cut-footer switch. It has been useful to ignore this difference between the two tools, but it's effectively a no-op now. Similar to when we repurposed this from --cut-header-footer in 83b0b8953e ("doc-diff: replace --cut-header-footer with --cut-footer", 2019-09-16), just drop it without worrying about any kind of backwards compatibility or user-base. Signed-off-by: Martin Ågren <martin.agren@gmail.com> --- Documentation/doc-diff | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/Documentation/doc-diff b/Documentation/doc-diff index aae5fc1933..97671ca65d 100755 --- a/Documentation/doc-diff +++ b/Documentation/doc-diff @@ -21,7 +21,6 @@ asciidoc use asciidoc with both commits to-asciidoc use asciidoc with the 'to'-commit to-asciidoctor use asciidoctor with the 'to'-commit asciidoctor use asciidoctor with both commits -cut-footer cut away footer " SUBDIRECTORY_OK=1 . "$(git --exec-path)/git-sh-setup" @@ -31,7 +30,6 @@ force= clean= from_program= to_program= -cut_footer= while test $# -gt 0 do case "$1" in @@ -55,8 +53,6 @@ do --asciidoc) from_program=-asciidoc to_program=-asciidoc ;; - --cut-footer) - cut_footer=-cut-footer ;; --) shift; break ;; *) @@ -118,8 +114,8 @@ construct_makemanflags () { from_makemanflags=$(construct_makemanflags "$from_program") && to_makemanflags=$(construct_makemanflags "$to_program") && -from_dir=$from_oid$from_program$cut_footer && -to_dir=$to_oid$to_program$cut_footer && +from_dir=$from_oid$from_program && +to_dir=$to_oid$to_program && # generate_render_makefile <srcdir> <dstdir> generate_render_makefile () { @@ -168,16 +164,6 @@ render_tree () { "$tmp/rendered/$dname+" | make -j$parallel -f - && mv "$tmp/rendered/$dname+" "$tmp/rendered/$dname" - - if test "$cut_footer" = "-cut-footer" - then - for f in $(find "$tmp/rendered/$dname" -type f) - do - head -n -2 "$f" | sed -e '${/^$/d}' >"$f+" && - mv "$f+" "$f" || - return 1 - done - fi fi }
Martin Ågren wrote: > On Fri, 14 May 2021 at 14:14, Felipe Contreras <felipe.contreras@gmail.com> wrote: > > > > Asciidoc automatically generates a date with format '%Y-%m-%d', while > > asciidoctor '%F'. > > Is that really the format Asciidoc uses? Not that it matters much for > the purposes of this patch. Yes: https://github.com/asciidoc-py/asciidoc-py/blob/main/asciidoc/asciidoc.py#L1189 > > I personally prefer the latter, so only modify it for diff purposes. > > I agree completely. > > > Fixes tons of these: > > > > -Git omitted 01/01/1970 GIT-ADD(1) > > +Git omitted 1970-01-01 GIT-ADD(1) > > > then > > - echo USE_ASCIIDOCTOR=YesPlease > > + echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_EXTRA='-adocdate="01/01/1970"' > > fi > > Nice. > > If you introduce a separate Makefile flag and incorporate Peff's patch > to doc-diff "asciidoctor" and "asciidoctor-direct", you'd need to > duplicate this a bit, or maybe just emit the ASCIIDOC_EXTRA outside of > the whole if chain. Indeed. > You could follow up with the patch below. If you'd rather keep it out of > your series to avoid it ballooning, fine. I can repost it later, once > the dust has settled. Don't let it hold up your work. I'll include it. Seems to fit the context. Cheers.
diff --git a/Documentation/doc-diff b/Documentation/doc-diff index ecd88b0524..aae5fc1933 100755 --- a/Documentation/doc-diff +++ b/Documentation/doc-diff @@ -111,7 +111,7 @@ construct_makemanflags () { echo USE_ASCIIDOCTOR= elif test "$1" = "-asciidoctor" then - echo USE_ASCIIDOCTOR=YesPlease + echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_EXTRA='-adocdate="01/01/1970"' fi }
In order to minimize the differences in the footer. Asciidoc automatically generates a date with format '%Y-%m-%d', while asciidoctor '%F'. I personally prefer the latter, so only modify it for diff purposes. Fixes tons of these: -Git omitted 01/01/1970 GIT-ADD(1) +Git omitted 1970-01-01 GIT-ADD(1) Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/doc-diff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)