[ntpsec commit] Documentation header, footer, and include visual cleanup.
Eric S. Raymond
esr at ntpsec.org
Sun Oct 18 09:35:14 UTC 2015
Module: ntpsec
Branch: master
Commit: 976375b7ab697c3aa73560af840efb8af3bad05b
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=976375b7ab697c3aa73560af840efb8af3bad05b
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Sun Oct 18 05:30:55 2015 -0400
Documentation header, footer, and include visual cleanup.
Fix up the title header on the index page.
Get rid of command.txt include, it duplicated links that were always
present in the footer.
Tweak the footer to look a bit more like the original Mills HTML.
Not a perfect match but as good as we're likely to get.
Fix a stale ntptickadj reference to point to ntpfrob.
Repair some broken inclusions.
---
devel-docs/TODO | 5 -----
docs/access.txt | 1 -
docs/accopt.txt | 1 -
docs/authopt.txt | 1 -
docs/confopt.txt | 1 -
docs/includes/command.txt | 8 --------
docs/includes/footer.txt | 2 +-
docs/includes/manual.txt | 2 +-
docs/index.txt | 2 +-
docs/miscopt.txt | 1 -
docs/monopt.txt | 1 -
docs/ntpd.txt | 4 ----
docs/ntpfrob.txt | 2 +-
docs/ntptime.txt | 2 +-
docs/ntptrace.txt | 2 +-
docs/sitemap.txt | 1 -
16 files changed, 6 insertions(+), 30 deletions(-)
diff --git a/devel-docs/TODO b/devel-docs/TODO
index 95a6a38..1e75103 100644
--- a/devel-docs/TODO
+++ b/devel-docs/TODO
@@ -99,11 +99,6 @@ they are salvageable.
scripts/plot_summary.txt
scripts/update-leap/update-leap.txt
-* In the docs subdirectory, include/command.txt is an HTML passthrough
- in a not entirely successful attempt to emulate the look of the
- Mills HTML documentation this directory was made from. It should be
- cleaned up or replaced.
-
* Similarly, includes/footer.txt is a tabular hack made to resemble the
old HTML and should be cleaned up.
diff --git a/docs/access.txt b/docs/access.txt
index 3e6b18c..ed925a4 100644
--- a/docs/access.txt
+++ b/docs/access.txt
@@ -12,7 +12,6 @@ The skunk watches for intruders and sprays.
== Related Links ==
include::includes/hand.txt[]
-include::includes/command.txt[]
include::includes/accopt.txt[]
'''''
diff --git a/docs/accopt.txt b/docs/accopt.txt
index 6006d03..1634a5f 100644
--- a/docs/accopt.txt
+++ b/docs/accopt.txt
@@ -11,7 +11,6 @@ The skunk watches for intruders and sprays.
== Related Links ==
-include::includes/command.txt[]
include::includes/accopt.txt[]
'''''
diff --git a/docs/authopt.txt b/docs/authopt.txt
index 1ec044f..3c6e1ea 100644
--- a/docs/authopt.txt
+++ b/docs/authopt.txt
@@ -12,7 +12,6 @@ Our resident cryptographer; now you see him, now you don't.
== Related Links ==
-include::includes/command.txt[]
include::includes/authopt.txt[]
'''''
diff --git a/docs/confopt.txt b/docs/confopt.txt
index 8e8463d..4be5824 100644
--- a/docs/confopt.txt
+++ b/docs/confopt.txt
@@ -11,7 +11,6 @@ The chicken is getting configuration advice.
== Related Links ==
-include::includes/command.txt[]
include::includes/confopt.txt[]
== Table of Contents ==
diff --git a/docs/includes/command.txt b/docs/includes/command.txt
deleted file mode 100644
index 2aa8f6c..0000000
--- a/docs/includes/command.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-<table><tr>
-<td width='33%' align='center'><img src='icons/home.gif' align='middle'>
-<a href='index.html'>Home Page</a></td>
-<td width='33%' align='center'><img src='icons/mail2.gif' align='middle'>
-<a href='http://www.ntp.org/contact'>Contacts</a></td>
-</tr></table>
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
diff --git a/docs/includes/footer.txt b/docs/includes/footer.txt
index 0b534b9..15d49f8 100644
--- a/docs/includes/footer.txt
+++ b/docs/includes/footer.txt
@@ -1,4 +1,4 @@
-[cols="3",grid="none",frame="none"]
+[cols="3",grid="none",frame="none",width="40%"]
|=========================================================
|image:icons/home.gif[float="left"]link:index.html[Home Page]|
image:icons/sitemap.png[float="left"]link::sitemap.html[Site Map]|
diff --git a/docs/includes/manual.txt b/docs/includes/manual.txt
index b3da951..e3b9aff 100644
--- a/docs/includes/manual.txt
+++ b/docs/includes/manual.txt
@@ -3,7 +3,7 @@
* link:ntpq.html[+{ntpq}+ - standard NTP query program]
* link:ntpdig.html[+{ntpdig}+ - Simple Network Time Protocol (SNTP) client]
* link:ntptrace.html[`ntptrace` - trace a chain of NTP servers back to the primary source]
-* link:ntptickadj.html[+{ntptickadj}+ - set time-related kernel variables]
+* link:ntpfrob.html[+{ntpfrob}+ - frob the local clock hardware]
* link:ntptime.html[+{ntptime}+ - read and set kernel time variables]
* link:ntpkeygen.html[+{ntpkeygen}+ - generate public and private keys]
* link:ntpdsim.html[+{ntpdsim}+ - Network Time Protocol (NTP) simulator]
diff --git a/docs/index.txt b/docs/index.txt
index 726c37e..c5eb903 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -1,4 +1,4 @@
-= The Network Time Protocol (NTP) Distribution =
+= The Secure Network Time Protocol (NTPsec) Distribution =
[cols="10%,90%",frame="none",grid="none",style="verse"]
|==============================
diff --git a/docs/miscopt.txt b/docs/miscopt.txt
index b80679a..37165f5 100644
--- a/docs/miscopt.txt
+++ b/docs/miscopt.txt
@@ -11,7 +11,6 @@ We have three, now looking for more.
== Related Links ==
-include::includes/command.txt[]
include::includes/miscopt.txt[]
'''''
diff --git a/docs/monopt.txt b/docs/monopt.txt
index 7c63904..e6e62c9 100644
--- a/docs/monopt.txt
+++ b/docs/monopt.txt
@@ -11,7 +11,6 @@ Pig was hired to watch the logs.
== Related Links ==
-include::includes/command.txt[]
include::includes/monopt.txt[]
== Table of Contents ==
diff --git a/docs/ntpd.txt b/docs/ntpd.txt
index 1d37199..1fec9b9 100644
--- a/docs/ntpd.txt
+++ b/docs/ntpd.txt
@@ -10,10 +10,6 @@ You need help from the monkeys.
|==============================
-== Related Links ==
-
-include::includes/command.txt[]
-
== Table of Contents ==
* link:#synop[Synopsis]
diff --git a/docs/ntpfrob.txt b/docs/ntpfrob.txt
index c191bbb..65d819e 100644
--- a/docs/ntpfrob.txt
+++ b/docs/ntpfrob.txt
@@ -1,6 +1,6 @@
= `ntpfrob` - frob the local clock hardware =
-include::includes/ntpfrob-body.txt
+include::includes/ntpfrob-body.txt[]
'''''
diff --git a/docs/ntptime.txt b/docs/ntptime.txt
index b7b5eef..61a6a97 100644
--- a/docs/ntptime.txt
+++ b/docs/ntptime.txt
@@ -11,7 +11,7 @@ The turtle has been swimming in the kernel.
'''''
-include::includes/ntptime-body.txt
+include::includes/ntptime-body.txt[]
'''''
diff --git a/docs/ntptrace.txt b/docs/ntptrace.txt
index ad0c68c..02dcbba 100644
--- a/docs/ntptrace.txt
+++ b/docs/ntptrace.txt
@@ -11,7 +11,7 @@ The rabbit knows the way back.
'''''
-include::includes/ntptrace-body.txt
+include::includes/ntptrace-body.txt[]
== Bugs ==
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index 7aabd41..013d1e1 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -14,7 +14,6 @@ Welcome to the tea party.
include::includes/install.txt[]
include::includes/manual.txt[]
include::includes/hand.txt[]
-include::includes/command.txt[]
include::includes/refclock.txt[]
include::includes/audio.txt[]
include::includes/misc.txt[]
More information about the vc
mailing list