Re: [chrony-dev] Documentation patch

[Bill Unruh]

The problem I have with asciidoctor is that it seems to be a redhat only
thing, at least in rpms. One should then tell people how to get asciidoctor 
in case their distro does not have it, and that one has to have ruby installed

in order to use it.



On Mon, 24 Oct 2016, Miroslav Lichvar wrote:


On Sat, Oct 22, 2016 at 05:46:53AM -0700, Bill Unruh wrote:

Probably. I am a bit confused why asciidoctor would be used instead of, the
seeming more prevalant, asciidoc, or either, set up by configure after testing
what the system has.


asciidoc is an older and well-known implementation, but it doesn't
render some parts of the chrony documentation correctly. asciidoctor
is strongly recommended.

--
Miroslav Lichvar

--
To unsubscribe email chrony-dev-requ...@chrony.tuxfamily.org with "unsubscribe" 
in the subject.
For help email chrony-dev-requ...@chrony.tuxfamily.org with "help" in the 
subject.
Trouble?  Email listmas...@chrony.tuxfamily.org.



--
To unsubscribe email chrony-dev-requ...@chrony.tuxfamily.org with "unsubscribe" 
in the subject.
For help email chrony-dev-requ...@chrony.tuxfamily.org with "help" in the 
subject.
Trouble?  Email listmas...@chrony.tuxfamily.org.

Re: [chrony-dev] Documentation patch

[Miroslav Lichvar]

On Sat, Oct 22, 2016 at 05:46:53AM -0700, Bill Unruh wrote:
> Probably. I am a bit confused why asciidoctor would be used instead of, the
> seeming more prevalant, asciidoc, or either, set up by configure after testing
> what the system has.

asciidoc is an older and well-known implementation, but it doesn't
render some parts of the chrony documentation correctly. asciidoctor
is strongly recommended.

-- 
Miroslav Lichvar

-- 
To unsubscribe email chrony-dev-requ...@chrony.tuxfamily.org with "unsubscribe" 
in the subject.
For help email chrony-dev-requ...@chrony.tuxfamily.org with "help" in the 
subject.
Trouble?  Email listmas...@chrony.tuxfamily.org.

Re: [chrony-dev] Documentation patch

[Håkan Johansson]

On Sat, 22 Oct 2016, Rune Magnussen wrote:


På Fri, 21 Oct 2016 16:11:16 -0700 (PDT)
Bill Unruh  skrev:

On Sat, 22 Oct 2016, Rune Magnussen wrote:


Hi

When trying to install chrony from source, I found out that the
README refered to INSTALL which does not exist. Also asciidoctor is
needed during install. here is a patch to fix the docs.


Not at all sure where you are getting your source for chrony.
Version 1.31.2 certainly has an INSTALL file. And I have no idea what
"asciidoctor" is and I certainly do not need it.

Which version of chrony are you refering to? And is this the source
from some distribution?



I just did af git clone from https://github.com/mlichvar/chrony

There is no INSTALL in the same directory as the README.
Where is the INSTALL supposed to be?


'grep -r INSTALL *' hints that in make_release there is a line

iconv -f utf-8 -t ascii//TRANSLIT < doc/installation.txt > INSTALL

such that doc/installation.txt in git ends up as INSTALL in a release.

Cheers,
Håkan

Re: [chrony-dev] Documentation patch

[Vincent Blut]

On Fri, Oct 21, 2016 at 04:35:55PM -0700, Bill Unruh wrote:


On Fri, 21 Oct 2016, Bill Unruh wrote:


On Sat, 22 Oct 2016, Rune Magnussen wrote:


Hi

When trying to install chrony from source, I found out that the README
refered to INSTALL which does not exist. Also asciidoctor is needed
during install. here is a patch to fix the docs.


Not at all sure where you are getting your source for chrony. 
Version 1.31.2 certainly has an INSTALL file. And I have no idea 
what

"asciidoctor" is and I certainly do not need it.


And in chrony 2.4 INSTALL is also there.


Not if one fetch sources from the git repository. The INSTALL file is 
still provided by the tarball though.


signature.asc
Description: PGP signature

Re: [chrony-dev] Documentation patch

[Bill Unruh]

On Sat, 22 Oct 2016, Rune Magnussen wrote:


Hi

When trying to install chrony from source, I found out that the README
refered to INSTALL which does not exist. Also asciidoctor is needed
during install. here is a patch to fix the docs.


Not at all sure where you are getting your source for chrony. 
Version 1.31.2 certainly has an INSTALL file. And I have no idea what

"asciidoctor" is and I certainly do not need it.

Which version of chrony are you refering to? And is this the source from some
distribution?






Regards Rune

diff --git a/README b/README
index 005cba1..af988f0 100644
--- a/README
+++ b/README
@@ -36,7 +36,7 @@ certain system calls and the kernel on your target
system. How do I set it up?
===

-The file INSTALL gives instructions.  On supported systems the
+The file doc/installation.adoc gives instructions.  On supported
systems the compilation process should be automatic.

You will need an ANSI C compiler -- gcc is recommended.
diff --git a/doc/installation.adoc b/doc/installation.adoc
index 151674a..6269ddb 100644
--- a/doc/installation.adoc
+++ b/doc/installation.adoc
@@ -97,7 +97,8 @@ superuser, and requires the following command to be
entered. make install


-This will install the binaries and man pages.
+This will install the binaries and man pages. The program asciidoctor
is +needed to generate the man pages. Without it, the install fails.

To install the HTML version of the manual, enter the command





--
To unsubscribe email chrony-dev-requ...@chrony.tuxfamily.org with "unsubscribe" 
in the subject.
For help email chrony-dev-requ...@chrony.tuxfamily.org with "help" in the 
subject.
Trouble?  Email listmas...@chrony.tuxfamily.org.