doc/man: follow man-pages(7) for section names/order and for "SEE ALSO"

Changes, following the "Sections within a manual page" section of
man-pages(7):

* Rename the "ENVIRONMENT VARIABLES" section to "ENVIRONMENT".

* Rename the "COPYRIGHTS" section to "COPYRIGHT".

* Move the "EXIT STATUS" section immediately after the "OPTIONS"
  section.

* Remove the "BUGS" section.

  Such a section indicates known bugs (why would you ever have such
  a section anyway?).

  The "RESOURCES" section now contains the URL of our bug tracker.

* Sort the manual pages by section, and then by name in the "SEE ALSO"
  section.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I3d91073ec876efd98dcc723ddf40272c814663dd

diff --git a/doc/man/common-cmd-footer.txt b/doc/man/common-cmd-footer.txt
index cd0ce8b762ca1d83e0a53cf5b5c0dc56b017c70e..86b4a8188ebdf2832426e1531db7ae1cd6fc59b3 100644 (file)
--- a/doc/man/common-cmd-footer.txt
+++ b/doc/man/common-cmd-footer.txt
@@ -1,5 +1,23 @@
-ENVIRONMENT VARIABLES
----------------------
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Command error
+
+*2*::
+    Undefined command
+
+*3*::
+    Fatal error
+
+*4*::
+    Command warning (something went wrong during the command)
+
+
+ENVIRONMENT
+-----------
 `LTTNG_ABORT_ON_ERROR`::
     Set to `1` to abort the process after the first error is
     encountered.
@@ -64,22 +82,4 @@ NOTE: `$LTTNG_HOME` defaults to the value of the `HOME` environment
 variable.
 
 
-EXIT STATUS
------------
-*0*::
-    Success
-
-*1*::
-    Command error
-
-*2*::
-    Undefined command
-
-*3*::
-    Fatal error
-
-*4*::
-    Command warning (something went wrong during the command)
-
-
 include::common-footer.txt[]

diff --git a/doc/man/common-footer.txt b/doc/man/common-footer.txt
index a51d64734c3112b007404c0097c4acbc09ca5dd7..0815ab60c315e6b544db3b9ddbb2d7ef4380ef81 100644 (file)
--- a/doc/man/common-footer.txt
+++ b/doc/man/common-footer.txt
@@ -1,23 +1,18 @@
-BUGS
-----
-If you encounter any issue or usability problem, please report it on the
-https://bugs.lttng.org/projects/lttng-tools[LTTng bug tracker].
-
-
 RESOURCES
 ---------
 * https://lttng.org[LTTng project website]
 * https://lttng.org/docs[LTTng documentation]
-* http://git.lttng.org[Git repositories]
-* http://github.com/lttng[GitHub organization]
-* http://ci.lttng.org/[Continuous integration]
-* http://lists.lttng.org[Mailing list] for support and
+* https://bugs.lttng.org[LTTng bug tracker]
+* https://git.lttng.org[Git repositories]
+* https://github.com/lttng[GitHub organization]
+* https://ci.lttng.org/[Continuous integration]
+* https://lists.lttng.org/[Mailing list] for support and
   development: `lttng-dev@lists.lttng.org`
 * irc://irc.oftc.net/lttng[IRC channel]: `#lttng` on `irc.oftc.net`
 
 
-COPYRIGHTS
-----------
+COPYRIGHT
+---------
 This program is part of the LTTng-tools project.
 
 LTTng-tools is distributed under the

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index a5ca19ef551a93376479dddabf1c496a8c0ab694..b1d11e931d70c4c1c7a721fad947d7e8995c336f 100644 (file)
--- a/doc/man/lttng-add-context.1.txt
+++ b/doc/man/lttng-add-context.1.txt
@@ -167,5 +167,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-enable-channel(1)
+man:lttng-enable-channel(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-add-trigger.1.txt b/doc/man/lttng-add-trigger.1.txt
index 5694d28d695dd03dcb8351f5b1ffc50c38f6687c..aee2380b352b2d4e9e3120ee8c49382627096b67 100644 (file)
--- a/doc/man/lttng-add-trigger.1.txt
+++ b/doc/man/lttng-add-trigger.1.txt
@@ -309,6 +309,6 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-list-triggers(1),
-man:lttng-remove-trigger(1)
+man:lttng-remove-trigger(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt
index 34714f699fac5c39437eca761973ba895fc739d0..f60a55b96d3896655a96e96405d9b46cd62e5b7a 100644 (file)
--- a/doc/man/lttng-clear.1.txt
+++ b/doc/man/lttng-clear.1.txt
@@ -76,6 +76,6 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
+man:lttng-concepts(7),
 man:lttng-relayd(8)

diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
index daac924f7d369cf8e72bbda1841fa3ff3bfc09ba..f3420a0100f9e068a05234954ddc1d7f981a8356 100644 (file)
--- a/doc/man/lttng-create.1.txt
+++ b/doc/man/lttng-create.1.txt
@@ -368,15 +368,15 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-destroy(1),
 man:lttng-enable-channel(1),
-man:lttng-list(8),
-man:lttng-relayd(8),
+man:lttng-list(1),
 man:lttng-rotate(1),
 man:lttng-save(1),
-man:lttng-sessiond(8),
 man:lttng-set-session(1),
 man:lttng-start(1),
-man:lttng-status(8),
-man:lttng-track(1)
+man:lttng-status(1),
+man:lttng-track(1),
+man:lttng-concepts(7),
+man:lttng-relayd(8),
+man:lttng-sessiond(8)

diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt
index 5084485fd2a8ce0103929a39e3bdddcb5c059d98..bed0a0053e90eb8a735c59eb39829c1fc2ef115b 100644 (file)
--- a/doc/man/lttng-destroy.1.txt
+++ b/doc/man/lttng-destroy.1.txt
@@ -88,6 +88,6 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
-man:lttng-list(1)
+man:lttng-list(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt
index 164dfdd2f987431a5af2bb4b5c6838d0decbaa30..9492a390391ab69ac856f115d2d30a1f4688ef56 100644 (file)
--- a/doc/man/lttng-disable-channel.1.txt
+++ b/doc/man/lttng-disable-channel.1.txt
@@ -67,5 +67,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-enable-channel(1)
+man:lttng-enable-channel(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt
index 82cea09889f9289dd9bc1b263eca345d5ce318fe..7ace9d1b4c9ff97814db813e331c493d433f41f6 100644 (file)
--- a/doc/man/lttng-disable-event.1.txt
+++ b/doc/man/lttng-disable-event.1.txt
@@ -156,6 +156,6 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-enable-event(1),
-man:lttng-list(1)
+man:lttng-list(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt
index 0c23031a6423522ac120be4b77801d43a962c194..0fc53afebc6bcc1af10774ff985d997ccc69b1aa 100644 (file)
--- a/doc/man/lttng-disable-rotation.1.txt
+++ b/doc/man/lttng-disable-rotation.1.txt
@@ -62,4 +62,5 @@ SEE ALSO
 --------
 man:lttng(1),
 man:lttng-enable-rotation(1),
-man:lttng-rotate(1)
+man:lttng-rotate(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index 271ada1ceb3b0bebb3407b039bda57f7fbc9e8ec..4da752f347451706b5c44a8e57a8564213c75d5f 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -354,6 +354,6 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-disable-channel(1),
-man:lttng-list(1)
+man:lttng-list(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index 5b096227e3025a124efd800d21e5d3de8d8728e3..439099b7fb0d2872b4bb2c7afef9a14f34deb4ff 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -854,9 +854,9 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-disable-event(1),
 man:lttng-enable-channel(1),
 man:lttng-list(1),
 man:lttng-start(1),
-man:lttng-track(1)
+man:lttng-track(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt
index d8ec88e75e4f28469a0201e35ace732f5d73d732..f965ed973e3bb2b1d06c4ef302520a4935b066c1 100644 (file)
--- a/doc/man/lttng-enable-rotation.1.txt
+++ b/doc/man/lttng-enable-rotation.1.txt
@@ -117,7 +117,7 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
 man:lttng-disable-rotation(1),
-man:lttng-rotate(1)
+man:lttng-rotate(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-event-rule.7.txt b/doc/man/lttng-event-rule.7.txt
index 3fad65c86d1da8bd7b906e28ab7221bc680f5804..3af260440d25ccd6f6e0cbb519a21abdc35b42e1 100644 (file)
--- a/doc/man/lttng-event-rule.7.txt
+++ b/doc/man/lttng-event-rule.7.txt
@@ -763,5 +763,5 @@ SEE ALSO
 --------
 man:lttng(1),
 man:lttng-add-trigger(1),
-man:lttng-concepts(7),
-man:lttng-list(1)
+man:lttng-list(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-list-triggers.1.txt b/doc/man/lttng-list-triggers.1.txt
index 83919a2c69ba3061a3c885a2546011b4bb04ce19..7d99869f2afc7efcddb936d233aa609f63c3c4ec 100644 (file)
--- a/doc/man/lttng-list-triggers.1.txt
+++ b/doc/man/lttng-list-triggers.1.txt
@@ -34,5 +34,5 @@ SEE ALSO
 --------
 man:lttng(1),
 man:lttng-add-trigger(1),
-man:lttng-concepts(7),
-man:lttng-remove-trigger(1)
+man:lttng-remove-trigger(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt
index f5cc3e203c116ed6fb29cb751d5c58151913ceec..545bc362890f4caf7486098d8062fdad2791977f 100644 (file)
--- a/doc/man/lttng-load.1.txt
+++ b/doc/man/lttng-load.1.txt
@@ -109,5 +109,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-save(1)
+man:lttng-save(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt
index 220225b31be8b8ae07dc8194340bdba013e33a31..6911f9fb80922e42d7ed80d2d7a616763154b7e2 100644 (file)
--- a/doc/man/lttng-metadata.1.txt
+++ b/doc/man/lttng-metadata.1.txt
@@ -39,5 +39,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-regenerate(1)
+man:lttng-regenerate(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 694eb49955852411ad650ef6c0cd30213a5d2a57..90cc1547d09d3e1c07c2ee6659cabbc359c900c3 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -280,8 +280,20 @@ option:-V, option:--version::
     Show version and quit.
 
 
-ENVIRONMENT VARIABLES
----------------------
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Error
+
+*3*::
+    Fatal error
+
+
+ENVIRONMENT
+-----------
 `LTTNG_ABORT_ON_ERROR`::
     Set to `1` to abort the process after the first error is
     encountered.
@@ -378,23 +390,11 @@ Override this path with the option:--output option.
 NOTE: `$LTTNG_HOME` defaults to `$HOME`.
 
 
-EXIT STATUS
------------
-*0*::
-    Success
-
-*1*::
-    Error
-
-*3*::
-    Fatal error
-
-
 include::common-footer.txt[]
 
 
 SEE ALSO
 --------
+man:babeltrace2(1),
 man:lttng(1),
-man:lttng-sessiond(8),
-man:babeltrace2(1)
+man:lttng-sessiond(8)

diff --git a/doc/man/lttng-remove-trigger.1.txt b/doc/man/lttng-remove-trigger.1.txt
index 59d5da12220064b46b413001bb7c64a971ada917..faf67b2f86d70bede1e18733b3a65965e2a27b1c 100644 (file)
--- a/doc/man/lttng-remove-trigger.1.txt
+++ b/doc/man/lttng-remove-trigger.1.txt
@@ -49,5 +49,5 @@ SEE ALSO
 --------
 man:lttng(1),
 man:lttng-add-trigger(1),
-man:lttng-concepts(7),
-man:lttng-list-triggers(1)
+man:lttng-list-triggers(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt
index baebea94b44e5bd187b90d29a6de89fa39381a85..50cb3102b3d2a35ae0335572e31477eb858680e8 100644 (file)
--- a/doc/man/lttng-rotate.1.txt
+++ b/doc/man/lttng-rotate.1.txt
@@ -96,6 +96,6 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-disable-rotation(1),
-man:lttng-enable-rotation(1)
+man:lttng-enable-rotation(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt
index baf51fded03b9ccfd6baf871cadba0fe0d369c65..36ef1d673f77edacf0653caa80da652b230e4597 100644 (file)
--- a/doc/man/lttng-save.1.txt
+++ b/doc/man/lttng-save.1.txt
@@ -78,5 +78,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-load(1)
+man:lttng-load(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt
index e9ec73d165ca4d126b349d05519a00e47855eaa2..4a8b4b6b2a1e666ded6bf099c8c8f97d3e063b60 100644 (file)
--- a/doc/man/lttng-sessiond.8.txt
+++ b/doc/man/lttng-sessiond.8.txt
@@ -302,8 +302,20 @@ option:-V, option:--version::
     Show version and quit.
 
 
-ENVIRONMENT VARIABLES
----------------------
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Error
+
+*3*::
+    Fatal error
+
+
+ENVIRONMENT
+-----------
 `LTTNG_ABORT_ON_ERROR`::
     Set to `1` to abort the process after the first error is
     encountered.
@@ -409,18 +421,6 @@ See the <<cfg,Daemon configuration>> section above to learn more.
 NOTE: `$LTTNG_HOME` defaults to `$HOME`.
 
 
-EXIT STATUS
------------
-*0*::
-    Success
-
-*1*::
-    Error
-
-*3*::
-    Fatal error
-
-
 include::common-footer.txt[]
 
 

diff --git a/doc/man/lttng-set-session.1.txt b/doc/man/lttng-set-session.1.txt
index 6c04caf927707d23428390a1cbdbc1bd6ac4d1f4..10f710abe940b24018dd84dd6706ad09d826cee7 100644 (file)
--- a/doc/man/lttng-set-session.1.txt
+++ b/doc/man/lttng-set-session.1.txt
@@ -41,6 +41,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
-man:lttng-destroy(1)
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index 94bf7c9f585c7e6b5aca7b8347d887ce40e59549..27c1e3d9c41821a9f97068bc3ac368da68b8160d 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -193,5 +193,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-create(1)
+man:lttng-create(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt
index 53b1c8aa74f4b32c46774547111047f4bc3e56db..9cc721de75eecfb8d2ed769498d4e892ff37c7b0 100644 (file)
--- a/doc/man/lttng-start.1.txt
+++ b/doc/man/lttng-start.1.txt
@@ -50,7 +50,7 @@ SEE ALSO
 --------
 man:lttng(1),
 man:lttng-add-trigger(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
 man:lttng-enable-event(1),
-man:lttng-stop(1)
+man:lttng-stop(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt
index 81f755d577afe2a1a5770a1b33b03aa1590e09cb..5f136f1aa606d37e2f46ca2533d6a37ed944c00b 100644 (file)
--- a/doc/man/lttng-status.1.txt
+++ b/doc/man/lttng-status.1.txt
@@ -40,7 +40,7 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
 man:lttng-list(1),
-man:lttng-set-session(1)
+man:lttng-set-session(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt
index c6f63c36c75e25cd3897b59407c8f5b5420dfa9a..4715872fe7efbf10044706d43daa73782ddde494 100644 (file)
--- a/doc/man/lttng-stop.1.txt
+++ b/doc/man/lttng-stop.1.txt
@@ -71,8 +71,8 @@ SEE ALSO
 --------
 man:lttng(1),
 man:lttng-add-trigger(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
 man:lttng-enable-event(1),
 man:lttng-rotate(1),
-man:lttng-start(1)
+man:lttng-start(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt
index 0e6cfceba9a40637dbc9df4ed9e1cfd1e723556f..d2768b12ccd2f6d59ca0a0fb9a5280f38b056d3a 100644 (file)
--- a/doc/man/lttng-track.1.txt
+++ b/doc/man/lttng-track.1.txt
@@ -297,5 +297,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-untrack(1)
+man:lttng-untrack(1),
+man:lttng-concepts(7)

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index 01e82b1b4368bbab722f9ebfb4478722885c6e76..d00b8921443d012e6b48edc49ecca00343f4efd2 100644 (file)
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -245,5 +245,5 @@ include::common-cmd-footer.txt[]
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-track(1)
+man:lttng-track(1),
+man:lttng-concepts(7)