From 46d5542cea5a5e456078a79401169635666df302 Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Sat, 22 Apr 2023 23:13:10 +0200 Subject: [PATCH] Rename/convert NEWS to NEWS.md No meaning in keeping RST (and, even more, half-RST/half-MD) around when for this Markdown is enough. Also ship SECURITY.MD in the sdist. --- MANIFEST.in | 4 ++- Makefile | 4 +-- NEWS => NEWS.md | 80 +++++++++++++++++++------------------------------ doc/index.rst | 2 +- doc/news.md | 1 + doc/news.rst | 1 - 6 files changed, 38 insertions(+), 54 deletions(-) rename NEWS => NEWS.md (81%) create mode 120000 doc/news.md delete mode 120000 doc/news.rst diff --git a/MANIFEST.in b/MANIFEST.in index 9c9a87d..a0863f6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,11 +1,13 @@ include COPYING include Makefile -include NEWS +include NEWS.md include README.rst +include SECURITY.md include acl.c include setup.cfg include doc/conf.py include doc/*.rst +include doc/*.md include tests/*.py include py.typed include posix1e.pyi diff --git a/Makefile b/Makefile index 55732ea..71e14b9 100644 --- a/Makefile +++ b/Makefile @@ -10,14 +10,14 @@ FULLVER = pylibacl-$(VERSION) DISTFILE = $(FULLVER).tar.gz MODNAME = posix1e.so -RSTFILES = doc/index.rst doc/module.rst doc/news.rst doc/readme.md doc/conf.py +DOCFILES = doc/index.rst doc/module.rst doc/news.md doc/readme.md doc/conf.py all: doc test $(MODNAME): acl.c $(PYTHON) ./setup.py build_ext --inplace -$(DOCHTML)/index.html: $(MODNAME) $(RSTFILES) acl.c +$(DOCHTML)/index.html: $(MODNAME) $(DOCFILES) acl.c $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCHTML) touch $@ diff --git a/NEWS b/NEWS.md similarity index 81% rename from NEWS rename to NEWS.md index 2e21058..37c07a2 100644 --- a/NEWS +++ b/NEWS.md @@ -1,8 +1,6 @@ -News -==== +# News -Version 0.6.0 -------------- +## Version 0.6.0 *Sun, 29 Nov 2020* @@ -52,8 +50,7 @@ Minor improvements: - The test suite has changed to `pytest`, which allows increased coverage via parameterisation. -Version 0.5.4 -------------- +## Version 0.5.4 *released Thu, 14 Nov 2019* @@ -69,8 +66,7 @@ Maintenance release: - Drop support (well, drop testing) for Python lower than 2.7. - Minor documentation improvements (closes #9, #12). -Version 0.5.3 -------------- +## Version 0.5.3 *released Thu, 30 Apr 2015* @@ -82,15 +78,13 @@ FreeBSD fixes: with regards to invalid ACLs (which we do exercise in the test suite), thanks again to Garret for the bug reports. -Version 0.5.2 -------------- +## Version 0.5.2 *released Sat, 24 May 2014* No visible changes release: just fix tests when running under pypy. -Version 0.5.1 -------------- +## Version 0.5.1 *released Sun, 13 May 2012* @@ -106,26 +100,23 @@ docstrings. Project reorganisation: the project home page has been moved from SourceForge to GitHub. -Version 0.5 ------------ +## Version 0.5 *released Sun, 27 Dec 2009* Added support for Python 3.x and improved support for Unicode filenames. -Version 0.4 ------------ +## Version 0.4 *released Sat, 28 Jun 2008* -License -~~~~~~~ +### License + Starting with this version, pylibacl is licensed under LGPL 2.1, Febryary 1999 or any later versions (see README.rst and COPYING). -Linux support -~~~~~~~~~~~~~ +### Linux support A few more Linux-specific functions: @@ -136,57 +127,48 @@ A few more Linux-specific functions: - add the acl_extended(...) function, which will check if an fd or path has an extended ACL -FreeBSD support -~~~~~~~~~~~~~~~ +### FreeBSD support FreeBSD 7.x will have almost all the acl manipulation functions that Linux has, with the exception of __getstate__/__setstate__. As a workaround, use the str() and ACL(text=...) methods to pass around textual representations. -Interface -~~~~~~~~~ +### Interface At module level there are now a few constants exported for easy-checking at runtime what features have been compiled in: -- HAS_ACL_FROM_MODE, denoting whether the ACL constructor supports the - mode=0xxx parameter +- `HAS_ACL_FROM_MODE`, denoting whether the ACL constructor supports + the `mode=0xxx` parameter -- HAS_ACL_CHECK, denoting whether ACL instances support the check() - method +- `HAS_ACL_CHECK`, denoting whether ACL instances support the + `check()` method -- HAS_ACL_ENTRY, denoting whether ACL manipulation is possible and the - Entry and Permset classes are available +- `HAS_ACL_ENTRY`, denoting whether ACL manipulation is possible and + the Entry and Permset classes are available -- HAS_EXTENEDED_CHECK, denoting whether the acl_extended function is - supported +- `HAS_EXTENEDED_CHECK`, denoting whether the `acl_extended()` + function is supported -- HAS_EQUIV_MODE, denoting whether ACL instances support the - equiv_mode() method +- `HAS_EQUIV_MODE`, denoting whether ACL instances support the + `equiv_mode()` method -Internals -~~~~~~~~~ +### Internals Many functions have now unittests, which is a good thing. -Version 0.3 ------------ +## Version 0.3 *released Sun, 21 Oct 2007* -Linux support -~~~~~~~~~~~~~ +### Linux support Under Linux, implement more functions from libacl: -- add ACL(mode=...), implementing acl_from_mode -- add ACL().to_any_text, implementing acl_to_any_text -- add ACL comparison, using acl_cmp -- add ACL().check, which is a more descriptive function than validate - -.. Local Variables: -.. mode: rst -.. fill-column: 72 -.. End: +- add `ACL(mode=...)`, implementing `acl_from_mode`. +- add `ACL.to_any_text()`, implementing `acl_to_any_text`. +- add ACL comparison, using `acl_cmp`. +- add `ACL.check()`, which is a more descriptive function than + validate. diff --git a/doc/index.rst b/doc/index.rst index f730027..5e266b3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,6 +15,6 @@ Contents security.md module.rst implementation.rst - news.rst + news.md Also see the :ref:`search`. diff --git a/doc/news.md b/doc/news.md new file mode 120000 index 0000000..9868b02 --- /dev/null +++ b/doc/news.md @@ -0,0 +1 @@ +../NEWS.md \ No newline at end of file diff --git a/doc/news.rst b/doc/news.rst deleted file mode 120000 index 0fae0f8..0000000 --- a/doc/news.rst +++ /dev/null @@ -1 +0,0 @@ -../NEWS \ No newline at end of file -- 2.39.5