Attachment 589152 Details for Bug 684354 – 0001-tasks-reference-modernize-the-OpenRC-init-scripts-do.patch

[patch] 0001-tasks-reference-modernize-the-OpenRC-init-scripts-do.patch

0001-tasks-reference-modernize-the-OpenRC-init-scripts-do.patch (text/plain), 4.11 KB, created by Michael Orlitzky on 2019-09-05 23:11:23 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Michael Orlitzky

Created: 2019-09-05 23:11:23 UTC

Size: 4.11 KB

patch

obsolete

>From 5408ae4a775349b3dfe0184622f7463894413cd1 Mon Sep 17 00:00:00 2001
>From: Michael Orlitzky <mjo@gentoo.org>
>Date: Thu, 25 Apr 2019 14:07:04 -0400
>Subject: [PATCH 1/1] tasks-reference: modernize the OpenRC "init scripts"
> documentation.
>
>The existing tasks-reference/init-scripts page suffers from a few
>problems. First, the OpenRC project no longer refers to its service
>scripts as "init scripts." The term "init scripts" generally refers to
>the SysV-style scripts that are incompatible with OpenRC. To avoid
>confusion, the name "OpenRC service scripts" is now used instead. The
>first thing this commit does it to rename the "Init Scripts" page to
>"OpenRC Service Scripts."
>
>Next, the implementation details of installing to /etc/init.d and
>/etc/conf.d have been removed. We already suggest using the doinitd
>and doconfd family of functions that exist precisely to hide that
>implementation detail from the developer.
>
>Finally, a link to the wiki has been replaced with pointers to the
>official OpenRC documentation that is kept up-to-date with respect to
>writing and modifying these service scripts.
>
>Closes: https://bugs.gentoo.org/684354
>Signed-off-by: Michael Orlitzky <mjo@gentoo.org>
>---
> tasks-reference/init-scripts/text.xml | 24 ---------------
> .../openrc-service-scripts/text.xml | 29 +++++++++++++++++++
> tasks-reference/text.xml | 2 +-
> 3 files changed, 30 insertions(+), 25 deletions(-)
> delete mode 100644 tasks-reference/init-scripts/text.xml
> create mode 100644 tasks-reference/openrc-service-scripts/text.xml
>
>diff --git a/tasks-reference/init-scripts/text.xml b/tasks-reference/init-scripts/text.xml
>deleted file mode 100644
>index e76670c..0000000
>--- a/tasks-reference/init-scripts/text.xml
>+++ /dev/null
>@@ -1,24 +0,0 @@
>-<?xml version="1.0"?>
>-<guide self="tasks-reference/init-scripts/">
>-<chapter>
>-<title>Init Scripts</title>
>-
>-<body>
>-
>-
>-Init scripts should be installed into <c>/etc/init.d</c> using the <c>doinitd</c> or
>-<c>newinitd</c> functions (see <uri link="::function-reference/install-functions/"/>).
>-Any configuration (commandline parameters or environment variables) for these scripts
>-should be handled via entries in <c>/etc/conf.d</c> with the same filename <d />
>-<c>doconfd</c> or <c>newconfd</c> can be used to install these.
>-
>-
>-
>-An overview of the Gentoo init system and how to write init scripts is available
>-in the <uri link="https://wiki.gentoo.org/wiki/Handbook:X86/Working/Initscripts#Writing_initscripts">
>-Writing Init Scripts section</uri>.
>-
>-
>-</body>
>-</chapter>
>-</guide>
>diff --git a/tasks-reference/openrc-service-scripts/text.xml b/tasks-reference/openrc-service-scripts/text.xml
>new file mode 100644
>index 0000000..1b92adb
>--- /dev/null
>+++ b/tasks-reference/openrc-service-scripts/text.xml
>@@ -0,0 +1,29 @@
>+<?xml version="1.0"?>
>+<guide self="tasks-reference/openrc-service-scripts/">
>+<chapter>
>+<title>OpenRC Service Scripts</title>
>+
>+<body>
>+
>+
>+OpenRC service scripts should be installed using the <uri
>+link="::function-reference/install-functions/"><c>doinitd</c> or
>+<c>newinitd</c> functions</uri>, and their associated configuration
>+files should be installed with either <uri
>+link="::function-reference/install-functions/"><c>doconfd</c> or
>+<c>newconfd</c></uri>.
>+
>+
>+
>+For writing and modifying OpenRC service scripts, the best source of
>+information is the official OpenRC documentation. In particular, be
>+sure to read the <c>openrc-run(8)</c> man page and the <uri
>+link="https://github.com/OpenRC/openrc/blob/master/service-script-guide.md">OpenRC
>+Service Script Guide</uri> that are installed along with the <uri
>+link="https://packages.gentoo.org/packages/sys-apps/openrc">sys-apps/openrc</uri>
>+package.
>+
>+
>+</body>
>+</chapter>
>+</guide>
>diff --git a/tasks-reference/text.xml b/tasks-reference/text.xml
>index 8de23bb..bc6aa85 100644
>--- a/tasks-reference/text.xml
>+++ b/tasks-reference/text.xml
>@@ -20,7 +20,7 @@ ebuilds.
> 
> <include href="completion/"/>
> <include href="environment/"/>
>-<include href="init-scripts/"/>
>+<include href="openrc-service-scripts/"/>
> <include href="pam/"/>
> <include href="perl-modules/"/>
> </guide>
>-- 
>2.21.0
>

Actions: View | Diff

Attachments on bug 684354: 574116 | 589152