Re: [PATCH 1/2] Documentation: Allow @@GIT_VERSION@@ in asciidoc.conf

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Frank Lichtenheld <frank@xxxxxxxxxxxxxx> writes:

> On Fri, Mar 23, 2007 at 02:53:58PM -0700, Junio C Hamano wrote:
> ...
>> While this is attractive to some degree, *I* am grumpy.  Doesn't
>> this patch make html and man branches update all files _every_
>> time any small change is made to some documentation?
>
> Not with my patch; which is a bug in the patch though because
> asciidoc.conf should really depend on GIT-VERSION-FILE.
>
> Another possibility would be to replace the @@GIT_VERSION@@ in the man pages
> themself and not in the asciidoc.conf. This would mean perhaps slightly
> bigger changes to the build system, but running sed on all the files is of
> course a lot faster than regenerating them with asciidoc.
>
> What do you think?

Ideally, I would like a solution that does not update the
resulting git-foo.html if I keep running these two commands
every time the tip of 'master' in the official repo is updated:

	$ git pull ;# get the latest 'master' from the official repo
	$ make -C Documentation
	: do not run 'make clean' here for the next round

when the only difference in git-foo.html left from the previous
round and this make would regenerate are embedded datestamps and
git version numbers in the output (same for manpages).  In other
words, if the description for the command changed between v1.4.4
and v1.5.0 but did not change at all in v1.5.1, provided that
the above sequence "pull && make" is the only thing that is ever
run in the repository (especially, no 'make clean' is ever run),
I would prefer the generated document to say it was formatted on
the day v1.5.0 was pushed out to the official repository, and
the document describes git v1.5.0, even after I did the above
command sequence on the day v1.5.1 is pushed out.  That would
prevent html and man branches from getting meaningless updates
that only change the embedded version numbers and datestamps.

In other words, I do not want the git-cat-file.html to mention
"v1.5.1-rc1-53-g2499857", if what it says has not changed since
v1.2.0.  I'd prefer to see "v1.2.0" there.

Which probably means that the version number should not be part
of the dependencies of generated documents, as far as 'make's
rebuilding decision is concerned.

If somebody wants all documentation to say what the latest git
is, s/he can do "make clean && make", even if you arrange it to
allow me do the above, but the opposite is more cumbersome and
error prone.


-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]