Skip to contentSkip to conversation

CONTRIBUTING.md: Drop dependency and build instructions

PATCH In review Daniel Burgener 3 participants 3 messages Jan 13, 2025 – Jan 16, 2025 SELinux security module

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 CONTRIBUTING.md: Drop dependency and build instructions

They are redundant with README.md, and haven't been kept up to date. For example, the CONTRIBUTING.md dependencies are missing the xmlto dependency. Rather than try to maintain this information in two places, just refer contributors to the README and keep the CONTRIBUTING doc focused on high level process.

---
 CONTRIBUTING.md | 9 +--------
 1 file changed, 1 insertion(+), 8 deletions(-)
CONTRIBUTING.md +1 -8
index 7c548e58..e6a677a0 100644
@@ -23,14 +23,7 @@ using a custom policy please include it as well.
 
 ## Compiling
 
-There are a number of dependencies required to build the userspace
-tools/libraries. On a Fedora system you can install them with yum:
-
-    # 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 pcre2-devel python-devel setools-devel swig ustr-devel
-
-The tools and libraries can be built and installed under a private directory from the top level with make, e.g.
-
-    $ make DESTDIR=~/obj install install-pywrap
+See README.md for instructions on how to compile and test this project.
 
 ## Contributing Code
 
Signature · 1 line
2.34.1
Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Daniel Burgener

They are redundant with README.md, and haven't been kept up to date. For example, the CONTRIBUTING.md dependencies are missing the xmlto dependency. Rather than try to maintain this information in two places, just refer contributors to the README and keep the CONTRIBUTING doc focused on high level process.

Quoted 28 lines
---
 CONTRIBUTING.md | 9 +--------
 1 file changed, 1 insertion(+), 8 deletions(-)
CONTRIBUTING.md +1 -9
index 7c548e58..e6a677a0 100644
@@ -23,14 +23,7 @@ using a custom policy please include it as well.
 
 ## Compiling
 
-There are a number of dependencies required to build the userspace
-tools/libraries. On a Fedora system you can install them with yum:
-
-    # 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 pcre2-devel python-devel setools-devel swig ustr-devel
-
-The tools and libraries can be built and installed under a private directory from the top level with make, e.g.
-
-    $ make DESTDIR=~/obj install install-pywrap
+See README.md for instructions on how to compile and test this project.
 
 ## Contributing Code
 
--

2.34.1

#2 lore raw
Quoted 9 lines · James Carter
Quoted 7 lines · Daniel Burgener

They are redundant with README.md, and haven't been kept up to date. For example, the CONTRIBUTING.md dependencies are missing the xmlto dependency. Rather than try to maintain this information in two places, just refer contributors to the README and keep the CONTRIBUTING doc focused on high level process.

Quoted 3 lines
Quoted 1 line

Merged. Thanks!

Quoted 28 lines
Quoted 28 lines
---
 CONTRIBUTING.md | 9 +--------
 1 file changed, 1 insertion(+), 8 deletions(-)
CONTRIBUTING.md +1 -9
index 7c548e58..e6a677a0 100644
@@ -23,14 +23,7 @@ using a custom policy please include it as well.
 
 ## Compiling
 
-There are a number of dependencies required to build the userspace
-tools/libraries. On a Fedora system you can install them with yum:
-
-    # 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 pcre2-devel python-devel setools-devel swig ustr-devel
-
-The tools and libraries can be built and installed under a private directory from the top level with make, e.g.
-
-    $ make DESTDIR=~/obj install install-pywrap
+See README.md for instructions on how to compile and test this project.
 
 ## Contributing Code
 
--

2.34.1