[gentoo-commits] proj/pax-utils:master commit in: /

["Sam James" <sam@gentoo.org>]

commit:     01b19ca9629c02d46af23f97c4afe4903c8b201a
Author:     Arsen Arsenović <arsen <AT> aarsen <DOT> me>
AuthorDate: Sat Jun 25 17:15:00 2022 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Tue Jul 12 06:33:20 2022 +0000
URL:        https://gitweb.gentoo.org/proj/pax-utils.git/commit/?id=01b19ca9

Improve build-related documentation

Signed-off-by: Arsen Arsenović <arsen <AT> aarsen.me>
Signed-off-by: Sam James <sam <AT> gentoo.org>

 README.md         | 13 +++----------
 meson_options.txt | 18 +++++++++++++-----
 2 files changed, 16 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 49277e0..539f3cc 100644
--- a/README.md
+++ b/README.md
@@ -18,16 +18,9 @@ Originally focused only on [PaX](https://pax.grsecurity.net/), it has been
 expanded to be generally security focused.  It still has a good number of
 PaX helpers for people interested in that.
 
-## Building
-
-Just run `make`.  This should work on any recent POSIX compliant system.
-
-Note: To rebuild the man-pages, you will need xmlto and the docbook-xml-dtd
-      packages installed on your system.
-
-## Installation
-
-`make install`
+## Building and installing
+pax-utils uses a bog-standard meson-based build system. See `meson_options.txt`
+for configuration options.
 
 You don't need PaX to use the pax-utils. Infact the only thing they
 really have in common is that pax-utils was initially written to aid in

diff --git a/meson_options.txt b/meson_options.txt
index 62adc35..c96865d 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -1,9 +1,17 @@
-option('lddtree_implementation', type : 'combo', choices : ['python', 'sh', 'none'], value : 'python')
-option('use_libcap', type : 'feature', value : 'auto')
+option('lddtree_implementation', type : 'combo',
+  choices : ['python', 'sh', 'none'], value : 'python',
+  description : 'Which lddtree implementation to install?')
+option('use_libcap', type : 'feature', value : 'auto',
+  description : 'Enable listing capabilities in pspax output (requires libcap)'
+)
 option('use_seccomp', type : 'boolean', value : 'true',
-  description : 'Enable seccomp filters at runtime (does *not* require libseccomp)'
+  description : 'Enable seccomp filters at runtime (does *not* require libseccomp, but does require kernel support)'
 )
 option('build_manpages', type : 'feature', value : 'auto',
   description : 'Build manuals via DocBook (requires xmlto)')
-option('tests', type : 'boolean', value : 'true')
-option('use_fuzzing', type : 'boolean', description : 'Also build LibFuzzer fuzzers', value : 'true')
+option('tests', type : 'boolean', value : 'true'
+  description : 'Enable testing (not guaranteed to work)'
+)
+option('use_fuzzing', type : 'boolean', value : 'true',
+  description : 'Also build LibFuzzer fuzzers as tests'
+)