docs: update the README.md with a basic SELinux description
Paul Moore
maintainerPATCH v3 1/1 docs: update the README.md with a basic SELinux description
This is to help meet the OpenSSF Best Practices requirements.
--- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-)
README.md +12 -7
@@ -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 <[email protected]>. - -Subscribe by sending "subscribe selinux" in the body of an email -to <[email protected]>. - -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 <[email protected]> +mailing list. You can subscribe by sending "subscribe selinux" in the body of +an email to <[email protected]>. Archives of the mailing list are +available at https://lore.kernel.org/selinux. Installation ------------
Quoted 3 lines · Paul Moore
This is to help meet the OpenSSF Best Practices requirements.
Signed-off-by Paul Moore <[email protected]>
Quoted 11 lines
--- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-)README.md +0
-0@@ -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)
README.md SELinux Userspace · line 11
Quoted 10 lines
README.md +2
-7-Please submit all bug reports and patches to <[email protected]>. - -Subscribe by sending "subscribe selinux" in the body of an email -to <[email protected]>. - -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?
Quoted 13 lines
README.md +10
-0+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 <[email protected]> +mailing list. You can subscribe by sending "subscribe selinux" in the body of +an email to <[email protected]>. Archives of the mailing list are +available at https://lore.kernel.org/selinux. Installation ------------
Paul Moore
maintainerQuoted 6 lines · Petr Lautrbach
Quoted 3 lines · Paul Moore
This is to help meet the OpenSSF Best Practices requirements.
Signed-off-by Paul Moore <[email protected]>Acked-by Petr Lautrbach <[email protected]>
Thanks Petr.
Quoted 24 lines
Quoted 11 lines
--- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-)README.md +0
-0@@ -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)README.md SELinux Userspace · line 11
Quoted 10 lines
README.md +2
-7-Please submit all bug reports and patches to <[email protected]>. - -Subscribe by sending "subscribe selinux" in the body of an email -to <[email protected]>. - -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^^
Quoted 2 lines
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.
Signature · 1 line
paul-moore.com
Quoted 50 lines · Paul Moore
Quoted 6 lines · Petr Lautrbach
Quoted 3 lines · Paul Moore
This is to help meet the OpenSSF Best Practices requirements.
Signed-off-by Paul Moore <[email protected]>Acked-by Petr Lautrbach <[email protected]>Thanks Petr.
Quoted 24 lines
Quoted 11 lines
--- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-)README.md +0
-0@@ -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)README.md SELinux Userspace · line 11
Quoted 10 lines
README.md +2
-7-Please submit all bug reports and patches to <[email protected]>. - -Subscribe by sending "subscribe selinux" in the body of an email -to <[email protected]>. - -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^^Quoted 2 lines
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 :)
Quoted 5 lines
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!