diff mbox

Update setenforce, getenforce, sestatus man pages with references to each other.

Message ID CAC7z9xBeQ7B5D-VG_RruwxAwWyChCghrvBuOaGc-YNsyrx4b_g@mail.gmail.com (mailing list archive)
State Not Applicable
Headers show

Commit Message

Ben Kane Jan. 29, 2018, 5:27 p.m. UTC
Hello,

Last week I was studying for the RHCSE certification, and I couldn't find
how
to change SELinux's status from enforcing to permissive in the man pages.
This
patch updates the relevant man pages.

- Switching emails

I emailed Daniel Walsh, the man page author, and he connected me to Petr
Lautrbach, who sent me to this mailing list (via my work email). The
maintainer, Stephen Smalley, said I should remove my company's legal blurb
at
the end of the email, and the email folks at my work (Acxiom Corp), said it
would be better to use my personal email anyway.

- Patch format

I hope the patch is formatted correctly. I tried to follow the notes on the
wiki (
https://github.com/SELinuxProject/selinux/wiki/Contributing#contributing-code
)
and I used a StackOverflow link (
https://stackoverflow.com/a/3418499/2958070 )
to generate the patchfile.

Thanks,

Benjamin Kane

Comments

Stephen Smalley Feb. 1, 2018, 2:34 p.m. UTC | #1
On Mon, 2018-01-29 at 11:27 -0600, Ben Kane wrote:
> Hello,
> 
> Last week I was studying for the RHCSE certification, and I couldn't
> find how
> to change SELinux's status from enforcing to permissive in the man
> pages. This
> patch updates the relevant man pages.
> 
> - Switching emails
> 
> I emailed Daniel Walsh, the man page author, and he connected me to
> Petr
> Lautrbach, who sent me to this mailing list (via my work email). The
> maintainer, Stephen Smalley, said I should remove my company's legal
> blurb at
> the end of the email, and the email folks at my work (Acxiom Corp),
> said it
> would be better to use my personal email anyway.
> 
> - Patch format
> 
> I hope the patch is formatted correctly. I tried to follow the notes
> on the
> wiki (
> https://github.com/SELinuxProject/selinux/wiki/Contributing#contribut
> ing-code )
> and I used a StackOverflow link ( https://stackoverflow.com/a/3418499
> /2958070 )
> to generate the patchfile.

These days people generally create patches by committing the change to
their locally cloned repository via git commit, then producing a patch
via git format-patch and emailing the result or directly sending it via
git send-email.  Inline patches are preferred over attachments since
that eases reading and commenting. See:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
for guidance for Linux kernel patches; we generally follow the same
approach although we aren't quite as strict.

Make sure you don't include anything above the first --- that you don't
want included in the commit message with your patch, e.g. much of your
content above isn't about the patch itself but rather asides that don't
really belong in the final log message.

One question I have is why cross-reference getenforce/setenforce from
the sestatus man page but not from the selinux man page.  If you were
starting from no SELinux knowledge, how would you have found the
sestatus man page in the first place?
Stephen Smalley Feb. 1, 2018, 2:50 p.m. UTC | #2
On Thu, 2018-02-01 at 09:34 -0500, Stephen Smalley wrote:
> On Mon, 2018-01-29 at 11:27 -0600, Ben Kane wrote:
> > Hello,
> > 
> > Last week I was studying for the RHCSE certification, and I
> > couldn't
> > find how
> > to change SELinux's status from enforcing to permissive in the man
> > pages. This
> > patch updates the relevant man pages.
> > 
> > - Switching emails
> > 
> > I emailed Daniel Walsh, the man page author, and he connected me to
> > Petr
> > Lautrbach, who sent me to this mailing list (via my work email).
> > The
> > maintainer, Stephen Smalley, said I should remove my company's
> > legal
> > blurb at
> > the end of the email, and the email folks at my work (Acxiom Corp),
> > said it
> > would be better to use my personal email anyway.
> > 
> > - Patch format
> > 
> > I hope the patch is formatted correctly. I tried to follow the
> > notes
> > on the
> > wiki (
> > https://github.com/SELinuxProject/selinux/wiki/Contributing#contrib
> > ut
> > ing-code )
> > and I used a StackOverflow link ( https://stackoverflow.com/a/34184
> > 99
> > /2958070 )
> > to generate the patchfile.
> 
> These days people generally create patches by committing the change
> to
> their locally cloned repository via git commit, then producing a
> patch
> via git format-patch and emailing the result or directly sending it
> via
> git send-email.  Inline patches are preferred over attachments since
> that eases reading and commenting. See:
> https://www.kernel.org/doc/html/latest/process/submitting-patches.htm
> l
> for guidance for Linux kernel patches; we generally follow the same
> approach although we aren't quite as strict.
> 
> Make sure you don't include anything above the first --- that you
> don't
> want included in the commit message with your patch, e.g. much of
> your
> content above isn't about the patch itself but rather asides that
> don't
> really belong in the final log message.
> 
> One question I have is why cross-reference getenforce/setenforce from
> the sestatus man page but not from the selinux man page.  If you were
> starting from no SELinux knowledge, how would you have found the
> sestatus man page in the first place?

BTW, the minimal fixes to apply this patch would include:
- Fix the patch description (remove anything not describing the change
itself, move any editorial notes after the first ---).
- Add a Signed-off-by: line signifying that you are contributing the
patch under the license associated with the upstream project; normally
this is generated for you when you run git commit -a -s and then
included in the output of git format-patch or git send-email.
diff mbox

Patch

diff --git a/libselinux/man/man8/getenforce.8 b/libselinux/man/man8/getenforce.8
index 70b9921..83bf132 100644
--- a/libselinux/man/man8/getenforce.8
+++ b/libselinux/man/man8/getenforce.8
@@ -15,4 +15,5 @@  Dan Walsh, <dwalsh@redhat.com>
 .SH "SEE ALSO"
 .BR selinux (8),
 .BR setenforce (8),
-.BR selinuxenabled (8)
+.BR selinuxenabled (8),
+.BR sestatus (8)
diff --git a/libselinux/man/man8/setenforce.8 b/libselinux/man/man8/setenforce.8
index 702041d..b6d2c13 100644
--- a/libselinux/man/man8/setenforce.8
+++ b/libselinux/man/man8/setenforce.8
@@ -29,3 +29,4 @@  Dan Walsh, <dwalsh@redhat.com>
 .BR selinux (8),
 .BR getenforce (8),
 .BR selinuxenabled (8)
+.BR sestatus (8)
diff --git a/policycoreutils/sestatus/sestatus.8 b/policycoreutils/sestatus/sestatus.8
index a89c53f..fea1669 100644
--- a/policycoreutils/sestatus/sestatus.8
+++ b/policycoreutils/sestatus/sestatus.8
@@ -73,7 +73,9 @@  Display the current state of booleans.
 This man page was written by Daniel Walsh <dwalsh@redhat.com>.
 .br
 The program was written by Chris PeBenito <pebenito@gentoo.org>
-
+.
 .SH "SEE ALSO"
-.BR selinux "(8), " sestatus.conf "(5)
-
+.BR selinux (8),
+.BR sestatus.conf (5),
+.BR setenforce (8),
+.BR getenforce (8)