| Message ID | 166480484056.9276.9459961157065300430.stgit@olly (mailing list archive) |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [v3] docs: update the README.md with a basic SELinux description | expand |
Paul Moore <paul@paul-moore.com> writes: > This is to help meet the OpenSSF Best Practices requirements. > > Signed-off-by: Paul Moore <paul@paul-moore.com> Acked-by: Petr Lautrbach <plautrba@redhat.com> > --- > README.md | 19 ++++++++++++------- > 1 file changed, 12 insertions(+), 7 deletions(-) > > diff --git a/README.md b/README.md > index 74b0a0c3..f54e0555 100644 > --- a/README.md > +++ b/README.md > @@ -7,13 +7,18 @@ SELinux Userspace > [](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux) > [](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml) > > -Please submit all bug reports and patches to <selinux@vger.kernel.org>. > - > -Subscribe by sending "subscribe selinux" in the body of an email > -to <majordomo@vger.kernel.org>. > - > -Archive of this mailing list is available on https://lore.kernel.org/selinux/. > - > +SELinux is a flexible Mandatory Access Control (MAC) system built into the > +Linux Kernel. SELinux provides administrators with a comprehensive access ^^ I was wondering, is the double whitespace intended? Is it something related to typography? > +control mechanism that enables greater access granularity over the existing > +Linux Discretionary Access Controls (DAC) and is present in many major Linux > +distributions. This repository contains the sources for the SELinux utilities > +and system libraries which allow for the configuration and management of an > +SELinux-based system. > + > +Please submit all bug reports and patches to the <selinux@vger.kernel.org> > +mailing list. You can subscribe by sending "subscribe selinux" in the body of > +an email to <majordomo@vger.kernel.org>. Archives of the mailing list are > +available at https://lore.kernel.org/selinux. > > Installation > ------------
On Fri, Nov 4, 2022 at 7:00 AM Petr Lautrbach <plautrba@redhat.com> wrote: > Paul Moore <paul@paul-moore.com> writes: > > This is to help meet the OpenSSF Best Practices requirements. > > > > Signed-off-by: Paul Moore <paul@paul-moore.com> > > Acked-by: Petr Lautrbach <plautrba@redhat.com> Thanks Petr. > > --- > > README.md | 19 ++++++++++++------- > > 1 file changed, 12 insertions(+), 7 deletions(-) > > > > diff --git a/README.md b/README.md > > index 74b0a0c3..f54e0555 100644 > > --- a/README.md > > +++ b/README.md > > @@ -7,13 +7,18 @@ SELinux Userspace > > [](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux) > > [](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml) > > > > -Please submit all bug reports and patches to <selinux@vger.kernel.org>. > > - > > -Subscribe by sending "subscribe selinux" in the body of an email > > -to <majordomo@vger.kernel.org>. > > - > > -Archive of this mailing list is available on https://lore.kernel.org/selinux/. > > - > > +SELinux is a flexible Mandatory Access Control (MAC) system built into the > > +Linux Kernel. SELinux provides administrators with a comprehensive access > > ^^ > > I was wondering, is the double whitespace intended? Is it something > related to typography? It was intentional, although the "correctness" is of some debate these days, or at least that is what I've read. Back when I was first learning to type the rule was two spaces after the end of a sentence, presumably to help make it easier to read, especially in print using older typefaces and machines. I've read a few articles that now indicate this method of typing is somewhat "out of style" and in fact most (all?) HTML/MD renders don't render the double whitespace unless an explicit " " or similar token is used. However, as I've been typing this way for many, many years, typing a double space after the period at the end of a sentence happens naturally ... good or bad :) Setting my typing habits aside, we *should* be consistent within the README.md file; if you would prefer me to respin the patch with a single space at the end of a sentence just let me know. Otherwise please feel free to make whatever changes you feel are necessary.
Paul Moore <paul@paul-moore.com> writes: > On Fri, Nov 4, 2022 at 7:00 AM Petr Lautrbach <plautrba@redhat.com> wrote: >> Paul Moore <paul@paul-moore.com> writes: >> > This is to help meet the OpenSSF Best Practices requirements. >> > >> > Signed-off-by: Paul Moore <paul@paul-moore.com> >> >> Acked-by: Petr Lautrbach <plautrba@redhat.com> > > Thanks Petr. > >> > --- >> > README.md | 19 ++++++++++++------- >> > 1 file changed, 12 insertions(+), 7 deletions(-) >> > >> > diff --git a/README.md b/README.md >> > index 74b0a0c3..f54e0555 100644 >> > --- a/README.md >> > +++ b/README.md >> > @@ -7,13 +7,18 @@ SELinux Userspace >> > [](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux) >> > [](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml) >> > >> > -Please submit all bug reports and patches to <selinux@vger.kernel.org>. >> > - >> > -Subscribe by sending "subscribe selinux" in the body of an email >> > -to <majordomo@vger.kernel.org>. >> > - >> > -Archive of this mailing list is available on https://lore.kernel.org/selinux/. >> > - >> > +SELinux is a flexible Mandatory Access Control (MAC) system built into the >> > +Linux Kernel. SELinux provides administrators with a comprehensive access >> >> ^^ >> >> I was wondering, is the double whitespace intended? Is it something >> related to typography? > > It was intentional, although the "correctness" is of some debate these > days, or at least that is what I've read. > > Back when I was first learning to type the rule was two spaces after > the end of a sentence, presumably to help make it easier to read, > especially in print using older typefaces and machines. I've read a > few articles that now indicate this method of typing is somewhat "out > of style" and in fact most (all?) HTML/MD renders don't render the > double whitespace unless an explicit " " or similar token is > used. However, as I've been typing this way for many, many years, > typing a double space after the period at the end of a sentence > happens naturally ... good or bad :) > > Setting my typing habits aside, we *should* be consistent within the > README.md file; if you would prefer me to respin the patch with a > single space at the end of a sentence just let me know. Otherwise > please feel free to make whatever changes you feel are necessary. > Merged without two spaces. Thanks!
diff --git a/README.md b/README.md index 74b0a0c3..f54e0555 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,18 @@ SELinux Userspace [](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux) [](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml) -Please submit all bug reports and patches to <selinux@vger.kernel.org>. - -Subscribe by sending "subscribe selinux" in the body of an email -to <majordomo@vger.kernel.org>. - -Archive of this mailing list is available on https://lore.kernel.org/selinux/. - +SELinux is a flexible Mandatory Access Control (MAC) system built into the +Linux Kernel. SELinux provides administrators with a comprehensive access +control mechanism that enables greater access granularity over the existing +Linux Discretionary Access Controls (DAC) and is present in many major Linux +distributions. This repository contains the sources for the SELinux utilities +and system libraries which allow for the configuration and management of an +SELinux-based system. + +Please submit all bug reports and patches to the <selinux@vger.kernel.org> +mailing list. You can subscribe by sending "subscribe selinux" in the body of +an email to <majordomo@vger.kernel.org>. Archives of the mailing list are +available at https://lore.kernel.org/selinux. Installation ------------
This is to help meet the OpenSSF Best Practices requirements. Signed-off-by: Paul Moore <paul@paul-moore.com> --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-)