diff mbox series

[v2,01/11] doc: doc-diff: set docdate manually

Message ID 20210521224452.530852-2-felipe.contreras@gmail.com (mailing list archive)
State New, archived
Headers show
Series doc: asciidoctor: direct man page creation and fixes | expand

Commit Message

Felipe Contreras May 21, 2021, 10:44 p.m. UTC
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)

Note that we have to add quotes when passing around $makemanflags, as it
now may contain whitespace due to multiple arguments (but the
dereference inside render_tree must remain unquoted, because it wants to perform
whitespace splitting to get the individual arguments back).

Comments-by: Jeff King <peff@peff.net>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/Makefile | 2 +-
 Documentation/doc-diff | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Bagas Sanjaya May 22, 2021, 4:25 a.m. UTC | #1
On 22/05/21 05.44, Felipe Contreras wrote:
> In order to minimize the differences in the footer.
> 
> Asciidoc automatically generates a date with format '%Y-%m-%d', while
> asciidoctor '%F'.
> 

%F is short yyyy-mm-dd date. AFAIK, it is the same effect as `%Y-%m-%d`.

> 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)
>
  
So, the asciidoctor generated date was the bottom one, while the asciidoc
counterpart was the above one, right?

The above one, however, was actually %m/%d/%Y.
Felipe Contreras May 22, 2021, 9:27 p.m. UTC | #2
Bagas Sanjaya wrote:
> On 22/05/21 05.44, Felipe Contreras wrote:
> > In order to minimize the differences in the footer.
> > 
> > Asciidoc automatically generates a date with format '%Y-%m-%d', while
> > asciidoctor '%F'.
> > 
> 
> %F is short yyyy-mm-dd date. AFAIK, it is the same effect as `%Y-%m-%d`.

Right, I noticed I was wrong when trying to use -adocdate in
asciidoctor. It's actually ignored.

The date format probably comes from docbook. The commit message needs to
be updated.

> > 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)
> >
>   
> So, the asciidoctor generated date was the bottom one, while the asciidoc
> counterpart was the above one, right?

Yeap.

> The above one, however, was actually %m/%d/%Y.

Indeed, the commit message is inaccurate.
diff mbox series

Patch

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 47053c78f8..b68ab57239 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -136,7 +136,7 @@  ASCIIDOC_EXTRA =
 ASCIIDOC_HTML = xhtml11
 ASCIIDOC_DOCBOOK = docbook
 ASCIIDOC_CONF = -f asciidoc.conf
-ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
+ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_FLAGS) $(ASCIIDOC_CONF) \
 		-amanmanual='Git Manual' -amansource='Git $(GIT_VERSION)'
 ASCIIDOC_DEPS = asciidoc.conf GIT-ASCIIDOCFLAGS
 TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
diff --git a/Documentation/doc-diff b/Documentation/doc-diff
index 1694300e50..c11b90a6ef 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_FLAGS='-adocdate="01/01/1970"'
 	fi
 }
 
@@ -181,6 +181,6 @@  render_tree () {
 	fi
 }
 
-render_tree $from_oid $from_dir $from_makemanflags &&
-render_tree $to_oid $to_dir $to_makemanflags &&
+render_tree $from_oid $from_dir "$from_makemanflags" &&
+render_tree $to_oid $to_dir "$to_makemanflags" &&
 git -C $tmp/rendered diff --no-index "$@" $from_dir $to_dir