Reformat and fix titles in documentation

OpenRC · Jan 12, 2018 · fee2ffe · mwgamera · Jul 27, 2023 · mwgamera
1 parent 8878f89
commit fee2ffe
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 23 deletions.
diff --git a/BUSYBOX.md b/BUSYBOX.md
@@ -1,4 +1,5 @@
-# Using Busybox as your Default Shell with OpenRC
+Using Busybox as your Default Shell with OpenRC
+===============================================
 
 If you have/bin/sh linked to busybox, you need to be aware of several
 incompatibilities between busybox's applets and the standalone

diff --git a/FEATURE-REMOVAL-SCHEDULE.md b/FEATURE-REMOVAL-SCHEDULE.md
@@ -1,19 +1,20 @@
-# Features Scheduled for Removal
+Features Scheduled for Removal
+==============================
 
 The following is a list of files and features that are going to be removed in
 the source tree.  Every entry should contain what exactly is going away, why it
 is happening, and who is going to be doing the work.  When the feature is
 removed, it should also be removed from this file.
 
-## Service pause action
+# Service pause action
 
 When: 1.0
 
 Why: The same affect can be obtained with the --nodeps option to stop.
 
 Who:
 
-## start-stop-daemon options --startas, --chuid , --oknodo
+# start-stop-daemon options --startas, --chuid , --oknodo
 
 When: 1.0
 
@@ -25,7 +26,7 @@ Why: Obsolete or replaced by other options.
 
 Who:
 
-## runscript and rc symbolic links
+# runscript and rc symbolic links
 
 When: 1.0
 
@@ -34,7 +35,7 @@ Why: Deprecated in favor of openrc-run and openrc due to naming
 
 Who:
 
-## support for the opts variable in service scripts
+# support for the opts variable in service scripts
 
 When: 1.0
 
@@ -43,15 +44,15 @@ Why: Deprecated in favor of extra_commands, extra_started_commands
 
 Who:
 
-## support for local_start and local_stop
+# support for local_start and local_stop
 
 When: 1.0
 
 Why: Deprecated in favor of executable scripts in @SYSCONFDIR@/local.d
 
 Who:
 
-## the mtab service script
+# the mtab service script
 
 When: force /etc/mtab to link to /proc/self/mounts in 1.0, remove
 	  service in 2.0
@@ -61,13 +62,13 @@ Why: /etc/mtab should be a symbolic link to /proc/self/mounts on modern
 
 Who:
 
-## C API Functions in rc.h
+# C API Functions in rc.h
 
 If you have a c program that links to librc and uses functions from
 there, this section will list API functions which are deprecated and
 will be removed along with the reason they are being removed.
 
-### rc_getline()
+## rc_getline()
 
 When: 1.0
 

diff --git a/HISTORY.md b/HISTORY.md
@@ -1,4 +1,5 @@
-# OpenRC History
+OpenRC History
+==============
 
 This history of OpenRC was written by Daniel Robbins, Roy Marples, William
 Hubbs and others.

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,5 @@
-# OpenRC NEWS
+OpenRC NEWS
+===========
 
 This file will contain a list of notable changes for each release. Note
 the information in this file is in reverse order.

diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
-# OpenRC README
+OpenRC README
+=============
 
 OpenRC is a dependency-based init system that works with the
 system-provided init program, normally `/sbin/init`. Currently, it does

diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md
@@ -1,4 +1,5 @@
-# OpenRC Style Guide
+OpenRC Coding Style Guide
+=========================
 
 This is the openrc style manual.  It governs the coding style of all code
 in this repository.  Follow it.  Contact [email protected] for any questions

diff --git a/agetty-guide.md b/agetty-guide.md
@@ -1,4 +1,5 @@
-# Setting up the agetty service in OpenRC
+Setting up the agetty service in OpenRC
+=================================xxxxxx
 
 The agetty service is an OpenRC specific way to monitor and respawn a
 getty, using agetty, on Linux. To use this method, make sure you aren't

diff --git a/runit-guide.md b/runit-guide.md
@@ -1,4 +1,5 @@
-# Using runit with OpenRC
+Using runit with OpenRC
+=======================
 
 Beginning with OpenRC-0.21, we support using runit [1] in place of
 start-stop-daemon for monitoring and restarting daemons.

diff --git a/s6-guide.md b/s6-guide.md
@@ -1,4 +1,5 @@
-# Using S6 with OpenRC
+Using S6 with OpenRC
+====================
 
 Beginning with OpenRC-0.16, we support using the s6 supervision suite
 from Skarnet Software in place of start-stop-daemon for monitoring

diff --git a/service-script-guide.md b/service-script-guide.md
@@ -1,4 +1,5 @@
-# OpenRC Service Script Writing Guide
+OpenRC Service Script Writing Guide
+===================================
 
 This document is aimed at developers or packagers who
 write OpenRC service scripts, either for their own projects, or for
@@ -13,7 +14,7 @@ don't consider anything exotic, and assume that you will use
 start-stop-daemon to manage a fairly typical long-running UNIX
 process.
 
-## Syntax of Service Scripts
+# Syntax of Service Scripts
 
 Service scripts are shell scripts. OpenRC aims at using only the standardized 
 POSIX sh subset for portability reasons. The default interpreter (build-time 
@@ -59,7 +60,7 @@ started or stopped, it should test the `$RC_CMD` variable, for example:
 [ "$RC_CMD" = restart ] && do_something
 ```
 
-## The Depend Function
+# The Depend Function
 
 This function declares the dependencies for a service script. This
 determines the order the service scripts start.
@@ -97,7 +98,7 @@ depend() {
 
 FIXME: Anything missing in this list?
 
-## The Default Functions
+# The Default Functions
 
 All service scripts are assumed to have the following functions:
 

diff --git a/supervise-daemon-guide.md b/supervise-daemon-guide.md
@@ -1,4 +1,5 @@
-# Using supervise-daemon
+Using supervise-daemon
+======================
 
 Beginning with OpenRC-0.21 we have our own daemon supervisor,
 supervise-daemon., which can start a daemon and restart it if it

diff --git a/support/deptree2dot/README.md b/support/deptree2dot/README.md
@@ -1,4 +1,5 @@
-# deptree2dot - Graph the OpenRC Dependency Tree
+deptree2dot - Graph the OpenRC Dependency Tree
+==============================================
 
 This utility can be used to graph the OpenRC dependency tree. It
 requires perl5.x and converts the tree to a .dot file which can be

diff --git a/support/init.d.examples/README.md b/support/init.d.examples/README.md
@@ -1,3 +1,6 @@
+Example OpenRC Service Scripts
+##############################
+
 The service scripts in this directory are meant as examples only.
 They are not installed by default as the scripts will need tweaking on a
 per distro basis. They are also non essential to the operation of the system.
diff --git a/support/openvpn/README.md b/support/openvpn/README.md
@@ -1,3 +1,6 @@
+Example OpenVPN Scripts
+=======================
+
 These handy scripts setup any dns information that OpenVPN may push.
 They also handle the interaction with OpenRC so that the OpenVPN service
 can become "inactive". This means that when it starts, it goes inactive and

diff --git a/support/sysvinit/README.md b/support/sysvinit/README.md
@@ -1,2 +1,5 @@
+OpenRC Sysvinit Support
+========================
+
 Here's a sample inittab for use with sysvinit for Linux based systems.
 We don't install it by default as sysvinit packages normally own this file.
diff --git a/user-guide.md b/user-guide.md
@@ -1,3 +1,6 @@
+OpenRC Users Guide
+==================
+
 # Purpose and description
 
 OpenRC is an init system for Unixoid operating systems. It takes care of