diff mbox series

docs: update the README.md with a basic SELinux description

Message ID 166457327058.375622.15969426802353557144.stgit@olly (mailing list archive)
State Changes Requested
Headers show
Series docs: update the README.md with a basic SELinux description | expand

Commit Message

Paul Moore Sept. 30, 2022, 9:27 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

Topi Miettinen Oct. 1, 2022, 7:14 a.m. UTC | #1
On 1.10.2022 0.27, 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..306d9ed6 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>
> +maling list.  You can subscribe by sending "subscribe selinux" in the body of

s/maling/mailing/

> +an email to <majordomo@vger.kernel.org>.  Archives of the mailing list are
> +available at https://lore.kernel.org/selinux.
>   
>   Installation
>   ------------
>
Paul Moore Oct. 1, 2022, 1:47 p.m. UTC | #2
On Sat, Oct 1, 2022 at 3:14 AM Topi Miettinen <toiwoton@gmail.com> wrote:
>
> On 1.10.2022 0.27, 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(-)

...

> > +Please submit all bug reports and patches to the <selinux@vger.kernel.org>
> > +maling list.  You can subscribe by sending "subscribe selinux" in the body of
>
> s/maling/mailing/

Nice catch, thanks.  I'll post a v2 right now.
diff mbox series

Patch

diff --git a/README.md b/README.md
index 74b0a0c3..306d9ed6 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>
+maling 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
 ------------