diff mbox series

[=v2] docs: update the README.md with a basic SELinux description

Message ID 166463207266.6015.2704084637353753709.stgit@olly (mailing list archive)
State Superseded
Headers show
Series [=v2] docs: update the README.md with a basic SELinux description | expand

Commit Message

Paul Moore Oct. 1, 2022, 1:47 p.m. UTC
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(-)

Comments

Daniel Burgener Oct. 3, 2022, 1:36 p.m. UTC | #1
On 10/1/2022 9:47 AM, Paul Moore wrote:
> 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(-)
> 
> diff --git a/README.md b/README.md
> index 74b0a0c3..e820ac30 100644
> --- a/README.md
> +++ b/README.md
> @@ -7,13 +7,18 @@ SELinux Userspace
>   [![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/selinux.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux)
>   [![CIFuzz Status](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml/badge.svg)](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 a
> +SELinux-based system.

Probably should be *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
>   ------------
Paul Moore Oct. 3, 2022, 1:47 p.m. UTC | #2
On Mon, Oct 3, 2022 at 9:36 AM Daniel Burgener
<dburgener@linux.microsoft.com> wrote:
> On 10/1/2022 9:47 AM, Paul Moore wrote:
> > 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(-)
> >
> > diff --git a/README.md b/README.md
> > index 74b0a0c3..e820ac30 100644
> > --- a/README.md
> > +++ b/README.md
> > @@ -7,13 +7,18 @@ SELinux Userspace
> >   [![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/selinux.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux)
> >   [![CIFuzz Status](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml/badge.svg)](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 a
> > +SELinux-based system.
>
> Probably should be *an* SELinux-based system.

Just posted a v3, thanks.
diff mbox series

Patch

diff --git a/README.md b/README.md
index 74b0a0c3..e820ac30 100644
--- a/README.md
+++ b/README.md
@@ -7,13 +7,18 @@  SELinux Userspace
 [![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/selinux.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux)
 [![CIFuzz Status](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml/badge.svg)](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 a
+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
 ------------