From 041a96276df6da443f6c5a7585a672675c8ac147 Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Thu, 14 Nov 2019 00:23:27 +0100 Subject: [PATCH] Update README about build requirements --- Makefile | 7 ++++--- README.rst | 14 ++++++++++---- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index 35b4344..7089a95 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,6 @@ +PYTHON = python3 SPHINXOPTS = -W -SPHINXBUILD = python3 -m sphinx +SPHINXBUILD = $(PYTHON) -m sphinx DOCDIR = doc DOCHTML = $(DOCDIR)/html DOCTREES = $(DOCDIR)/doctrees @@ -11,7 +12,7 @@ RSTFILES = doc/index.rst doc/module.rst NEWS README.rst doc/conf.py all: doc test $(MODNAME): acl.c - ./setup.py build_ext --inplace + $(PYTHON) ./setup.py build_ext --inplace $(DOCHTML)/index.html: $(MODNAME) $(RSTFILES) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCHTML) @@ -20,7 +21,7 @@ $(DOCHTML)/index.html: $(MODNAME) $(RSTFILES) doc: $(DOCHTML)/index.html dist: - fakeroot ./setup.py sdist + fakeroot $(PYTHON) ./setup.py sdist test: @for ver in 2.7 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7; do \ diff --git a/README.rst b/README.rst index 24d2f91..f736c16 100644 --- a/README.rst +++ b/README.rst @@ -22,13 +22,19 @@ FreeBSD 7 also has quite good support. If any other platform implements the POSIX.1e draft, pylibacl can be used. I heard that Solaris does, but I can't test it. -- Python 2.7 or newer -- operating system: +- Python 2.7 or newer. +- Operating system: - Linux, kernel v2.4 or newer, and the libacl library and development packages (all modern distributions should have this, under various names); also the file-systems you use must have - ACLs turned on, either as a compile or mount option - - FreeBSD 7.0 or newer + ACLs turned on, either as a compile or mount option. + - FreeBSD 7.0 or newer. +- The sphinx python module, for your python version, if building the + documentation. + +Note: to build from source, by default, Python 3 is needed. It can +still be built with Python 2, by calling `make PYTHON=python2`. + License ------- -- 2.39.5