diff mbox series

[v2] Convert README to README.md

Message ID 20200423185449.223595-1-plautrba@redhat.com (mailing list archive)
State Accepted
Headers show
Series [v2] Convert README to README.md | expand

Commit Message

Petr Lautrbach April 23, 2020, 6:54 p.m. UTC 
It should make the document readable for github users.

Fixes: https://github.com/SELinuxProject/selinux/issues/225

Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
---

- Fixed indentation in yum command

 README    | 25 -------------------------
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 25 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

Comments

Paul Moore April 23, 2020, 7:29 p.m. UTC | #1 
On Thu, Apr 23, 2020 at 2:55 PM Petr Lautrbach <plautrba@redhat.com> wrote:
>
> It should make the document readable for github users.
>
> Fixes: https://github.com/SELinuxProject/selinux/issues/225
>
> Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
> ---
>
> - Fixed indentation in yum command
>
>  README    | 25 -------------------------
>  README.md | 41 +++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 41 insertions(+), 25 deletions(-)
>  delete mode 100644 README
>  create mode 100644 README.md

Thanks Petr.  For whatever it's worth, here is my ACK.

Acked-by: Paul Moore <paul@paul-moore.com>

> diff --git a/README b/README
> deleted file mode 100644
> index e4423ca23b58..000000000000
> --- a/README
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -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.
> -
> -Build dependencies on Fedora:
> -yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
> -
> -To build and install everything under a private directory, run:
> -make DESTDIR=~/obj install install-pywrap
> -
> -To install as the default system libraries and binaries
> -(overwriting any previously installed ones - dangerous!),
> -on x86_64, run:
> -make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
> -or on x86 (32-bit), run:
> -make install install-pywrap relabel
> -
> -This may render your system unusable if the upstream SELinux userspace
> -lacks library functions or other dependencies relied upon by your
> -distribution.  If it breaks, you get to keep both pieces.
> -
> -To install libsepol on macOS (mainly for policy analysis):
> -cd libsepol; make PREFIX=/usr/local install
> -
> -This requires GNU coreutils (brew install coreutils).
> diff --git a/README.md b/README.md
> new file mode 100644
> index 000000000000..974280f9d14f
> --- /dev/null
> +++ b/README.md
> @@ -0,0 +1,41 @@
> +SELinux Userspace
> +=================
> +
> +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>.
> +
> +Installation
> +------------
> +
> +Build dependencies on Fedora:
> +
> +    yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
> +
> +
> +To build and install everything under a private directory, run:
> +
> +    make DESTDIR=~/obj install install-pywrap
> +
> +To install as the default system libraries and binaries
> +(overwriting any previously installed ones - dangerous!),
> +on x86_64, run:
> +
> +    make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
> +
> +or on x86 (32-bit), run:
> +
> +    make install install-pywrap relabel
> +
> +This may render your system unusable if the upstream SELinux userspace
> +lacks library functions or other dependencies relied upon by your
> +distribution.  If it breaks, you get to keep both pieces.
> +
> +To install libsepol on macOS (mainly for policy analysis):
> +
> +    cd libsepol; make PREFIX=/usr/local install
> +
> +This requires GNU coreutils:
> +
> +    brew install coreutils
> --
> 2.26.0
>
Nicolas Iooss April 26, 2020, 1:02 p.m. UTC | #2 
On Thu, Apr 23, 2020 at 9:29 PM Paul Moore <paul@paul-moore.com> wrote:
>
> On Thu, Apr 23, 2020 at 2:55 PM Petr Lautrbach <plautrba@redhat.com> wrote:
> >
> > It should make the document readable for github users.
> >
> > Fixes: https://github.com/SELinuxProject/selinux/issues/225
> >
> > Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
> > ---
> >
> > - Fixed indentation in yum command
> >
> >  README    | 25 -------------------------
> >  README.md | 41 +++++++++++++++++++++++++++++++++++++++++
> >  2 files changed, 41 insertions(+), 25 deletions(-)
> >  delete mode 100644 README
> >  create mode 100644 README.md
>
> Thanks Petr.  For whatever it's worth, here is my ACK.
>
> Acked-by: Paul Moore <paul@paul-moore.com>

Thanks :) I will improve the README a little bit more (adding a
Travis-CI badge, listing Debian build dependencies, adding
"install-rubywrap"...) and send a patch to be applied on top of this
one.

Acked-by: Nicolas Iooss <nicolas.iooss@m4x.org>

Nicolas

>
> > diff --git a/README b/README
> > deleted file mode 100644
> > index e4423ca23b58..000000000000
> > --- a/README
> > +++ /dev/null
> > @@ -1,25 +0,0 @@
> > -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.
> > -
> > -Build dependencies on Fedora:
> > -yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
> > -
> > -To build and install everything under a private directory, run:
> > -make DESTDIR=~/obj install install-pywrap
> > -
> > -To install as the default system libraries and binaries
> > -(overwriting any previously installed ones - dangerous!),
> > -on x86_64, run:
> > -make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
> > -or on x86 (32-bit), run:
> > -make install install-pywrap relabel
> > -
> > -This may render your system unusable if the upstream SELinux userspace
> > -lacks library functions or other dependencies relied upon by your
> > -distribution.  If it breaks, you get to keep both pieces.
> > -
> > -To install libsepol on macOS (mainly for policy analysis):
> > -cd libsepol; make PREFIX=/usr/local install
> > -
> > -This requires GNU coreutils (brew install coreutils).
> > diff --git a/README.md b/README.md
> > new file mode 100644
> > index 000000000000..974280f9d14f
> > --- /dev/null
> > +++ b/README.md
> > @@ -0,0 +1,41 @@
> > +SELinux Userspace
> > +=================
> > +
> > +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>.
> > +
> > +Installation
> > +------------
> > +
> > +Build dependencies on Fedora:
> > +
> > +    yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
> > +
> > +
> > +To build and install everything under a private directory, run:
> > +
> > +    make DESTDIR=~/obj install install-pywrap
> > +
> > +To install as the default system libraries and binaries
> > +(overwriting any previously installed ones - dangerous!),
> > +on x86_64, run:
> > +
> > +    make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
> > +
> > +or on x86 (32-bit), run:
> > +
> > +    make install install-pywrap relabel
> > +
> > +This may render your system unusable if the upstream SELinux userspace
> > +lacks library functions or other dependencies relied upon by your
> > +distribution.  If it breaks, you get to keep both pieces.
> > +
> > +To install libsepol on macOS (mainly for policy analysis):
> > +
> > +    cd libsepol; make PREFIX=/usr/local install
> > +
> > +This requires GNU coreutils:
> > +
> > +    brew install coreutils
> > --
> > 2.26.0
> >
>
>
> --
> paul moore
> www.paul-moore.com
Paul Moore April 26, 2020, 8:54 p.m. UTC | #3 
On Sun, Apr 26, 2020 at 9:02 AM Nicolas Iooss <nicolas.iooss@m4x.org> wrote:
>
> On Thu, Apr 23, 2020 at 9:29 PM Paul Moore <paul@paul-moore.com> wrote:
> >
> > On Thu, Apr 23, 2020 at 2:55 PM Petr Lautrbach <plautrba@redhat.com> wrote:
> > >
> > > It should make the document readable for github users.
> > >
> > > Fixes: https://github.com/SELinuxProject/selinux/issues/225
> > >
> > > Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
> > > ---
> > >
> > > - Fixed indentation in yum command
> > >
> > >  README    | 25 -------------------------
> > >  README.md | 41 +++++++++++++++++++++++++++++++++++++++++
> > >  2 files changed, 41 insertions(+), 25 deletions(-)
> > >  delete mode 100644 README
> > >  create mode 100644 README.md
> >
> > Thanks Petr.  For whatever it's worth, here is my ACK.
> >
> > Acked-by: Paul Moore <paul@paul-moore.com>
>
> Thanks :) I will improve the README a little bit more (adding a
> Travis-CI badge, listing Debian build dependencies, adding
> "install-rubywrap"...) and send a patch to be applied on top of this
> one.

I think those all sound like good improvements.  Thanks guys.
Nicolas Iooss April 28, 2020, 7:32 a.m. UTC | #4 
On Sun, Apr 26, 2020 at 10:54 PM Paul Moore <paul@paul-moore.com> wrote:
>
> On Sun, Apr 26, 2020 at 9:02 AM Nicolas Iooss <nicolas.iooss@m4x.org> wrote:
> >
> > On Thu, Apr 23, 2020 at 9:29 PM Paul Moore <paul@paul-moore.com> wrote:
> > >
> > > On Thu, Apr 23, 2020 at 2:55 PM Petr Lautrbach <plautrba@redhat.com> wrote:
> > > >
> > > > It should make the document readable for github users.
> > > >
> > > > Fixes: https://github.com/SELinuxProject/selinux/issues/225
> > > >
> > > > Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
> > > > ---
> > > >
> > > > - Fixed indentation in yum command
> > > >
> > > >  README    | 25 -------------------------
> > > >  README.md | 41 +++++++++++++++++++++++++++++++++++++++++
> > > >  2 files changed, 41 insertions(+), 25 deletions(-)
> > > >  delete mode 100644 README
> > > >  create mode 100644 README.md
> > >
> > > Thanks Petr.  For whatever it's worth, here is my ACK.
> > >
> > > Acked-by: Paul Moore <paul@paul-moore.com>
> >
> > Thanks :) I will improve the README a little bit more (adding a
> > Travis-CI badge, listing Debian build dependencies, adding
> > "install-rubywrap"...) and send a patch to be applied on top of this
> > one.
>
> I think those all sound like good improvements.  Thanks guys.

I merged the commit and am still preparing improvements (if you are
interested, the work-in-progress is available at
https://github.com/fishilico/selinux/blob/wip/README.md).

Thanks,
Nicolas
diff mbox series

Patch

diff --git a/README b/README
deleted file mode 100644
index e4423ca23b58..000000000000
--- a/README
+++ /dev/null
@@ -1,25 +0,0 @@ 
-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.
-
-Build dependencies on Fedora:
-yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
-
-To build and install everything under a private directory, run:
-make DESTDIR=~/obj install install-pywrap
-
-To install as the default system libraries and binaries
-(overwriting any previously installed ones - dangerous!),
-on x86_64, run:
-make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
-or on x86 (32-bit), run:
-make install install-pywrap relabel
-
-This may render your system unusable if the upstream SELinux userspace
-lacks library functions or other dependencies relied upon by your
-distribution.  If it breaks, you get to keep both pieces.
-
-To install libsepol on macOS (mainly for policy analysis):
-cd libsepol; make PREFIX=/usr/local install
-
-This requires GNU coreutils (brew install coreutils).
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..974280f9d14f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@ 
+SELinux Userspace
+=================
+
+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>.
+
+Installation
+------------
+
+Build dependencies on Fedora:
+
+    yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
+
+
+To build and install everything under a private directory, run:
+
+    make DESTDIR=~/obj install install-pywrap
+
+To install as the default system libraries and binaries
+(overwriting any previously installed ones - dangerous!),
+on x86_64, run:
+
+    make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
+
+or on x86 (32-bit), run:
+
+    make install install-pywrap relabel
+
+This may render your system unusable if the upstream SELinux userspace
+lacks library functions or other dependencies relied upon by your
+distribution.  If it breaks, you get to keep both pieces.
+
+To install libsepol on macOS (mainly for policy analysis):
+
+    cd libsepol; make PREFIX=/usr/local install
+
+This requires GNU coreutils:
+
+    brew install coreutils