Prepare documentation for release

.gitignore

@@ -4,7 +4,9 @@
 *.html
 *.info
 *.o
+*.1
 doc/*.h
+*rpm-spec
 doc/public_html/
 gcov-latest/
 public/

AUTHORS

@@ -30,3 +30,6 @@ Denis FERRANTI <denis.ferranti@st.com>
 
 Paul GHALEB <paul.ghaleb@st.com>
         User manual review.
+
+Lucas Ramage <ramage.lucas@protonmail.com>
+        Website re-design, documentation, maintainer.

CHANGELOG.rst

@@ -0,0 +1,105 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on `Keep a Changelog`_, and this project adheres to
+`Semantic Versioning`_.
+
+Unreleased
+------------
+
+Please see `Unreleased Changes`_ for more information.
+
+5.2.0-alpha - 2020-04-14
+------------------------
+
+Added
+~~~~~
+
+-  GitLab CI/CD pipelines for static binaries.
+
+-  Python extension.
+
+-  Secure disclosure instructions.
+
+-  Vagrantfiles for kernel-specific testing.
+
+-  Support for Musl libc.
+
+-  Use shellcheck for scripts.
+
+-  link2symlink extension.
+
+-  Contributor scripts care2docker.sh, and care_rearchiver.sh
+
+-  Clang scan-build and gcov/lcov for source code analysis.
+
+-  Trivial chroot using relative paths.
+
+-  port_mapper extension.
+
+-  Commandline option --kill-on-exit.
+
+-  Hidden PROOT_TMPDIR option.
+
+-  Support for sudo via fake_id0 extension.
+
+Changed
+~~~~~~~
+
+-  Started using top-level changelog instead of individual ones.
+
+-  Limit testsuite to five minutes.
+
+-  Updated release instructions.
+
+-  Renamed tests to test.
+
+-  Replace .exe file extension with .elf for loader binaries.
+
+-  Use LC_ALL instead of LANG.
+
+-  Semantics for HOST_PATH extension event arguments.
+
+Removed
+~~~~~~~
+
+-  Disabled, deprecated, or unreliable tests.
+
+-  Drop Coverity from Travis CI.
+
+-  Cross-compiling scripts for Slackware.
+
+-  FHS assumptions from tests.
+
+-  References to proot.me domain.
+
+Fixed
+~~~~~
+
+-  Error-code handling in substitute_binding_stat.
+
+-  Prevent tracees from becoming undumpable.
+
+-  Merged patches for detecting kernels >= 4.8.
+
+-  GIT_VERSION for development binaries.
+
+-  Replace mktemp with mkstemp.
+
+-  File permissions for test scripts.
+
+-  Filter renamteat2 syscall.
+
+-  Honor GNU standards regarding DESTDIR variable.
+
+-  Cleanup tmp on non-ext file systems.
+
+-  Reallocation of heap for CLONE_VM on execve syscall.
+
+-  Non-executable stack for binaries.
+
+.. _Unreleased Changes: https://github.com/proot-me/proot/compare/v5.2.0-alpha...master
+.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0
+.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html

doc/GNUmakefile

@@ -21,26 +21,26 @@ dist: $(OUTPUTS)
 	@cp ${DOC_DIR}/../README.rst ${SITE_DIR}/
 	@cp ${DOC_DIR}/../HACKING.rst ${SITE_DIR}/
 
-%/man.1: %/manual.txt
+%/man.1: %/manual.rst
 	$(RST2MAN) $< $@
 
-%.xml: %.txt
+%.xml: %.rst
 	$(RST2XML) --no-doctype $< $@
 
-%.html: %.txt
+%.html: %.rst
 	$(RST2HTML) $< $@
 
 # Workaround to avoid unescaped C character.
-%/manual-quoted.txt: %/manual.txt
+%/manual-quoted.rst: %/manual.rst
 	sed 's/"/\\\\"/g' $^ > $@
 
 %.h: %/stylesheets/cli.xsl %/manual-quoted.xml
 	xsltproc --output $@ $^
 
-%/rpm-spec:  %/stylesheets/rpm-spec.xsl %/manual.xml # %/changelog.txt
+%/rpm-spec:  %/stylesheets/rpm-spec.xsl %/manual.xml # %/changelog.rst
 	xsltproc --output $@ $^
 	echo "* $(shell date +'%a %b %d %Y') PRoot Team <proot_me@googlegroups.com>" >> $@
-	cat $*/changelog.txt >> $@
+	cat $*/changelog.rst >> $@
 
 %/index.html: stylesheets/website.xsl %/stylesheets/website.xsl %/manual.xml
 	xsltproc --output $@ $*/stylesheets/website.xsl $*/manual.xml

doc/care/changelog.txt → doc/care/changelog.rst

@@ -1,3 +1,13 @@
+=======================================================================
+=======================================================================
+
+  This file is no longer used for tracking changes for CARE. For
+  user visible changes, please look in the top-level CHANGELOG.rst
+  file.
+
+=======================================================================
+=======================================================================
+
 CARE v2.2
 =========
 

doc/care/manual.txt → doc/care/manual.rst

@@ -452,7 +452,7 @@ Colophon
 ========
 
 Visit https://proot-me.github.io for help, bug reports, suggestions, patches, ...
-Copyright (C) 2015 STMicroelectronics, licensed under GPL v2 or later.
+Copyright (C) 2020 PRoot Developers, licensed under GPL v2 or later.
 
 ::
 

doc/howto-release.rst

@@ -44,9 +44,9 @@ which can be optionally distributed for each release:
 Documentation Update
 --------------------
 
-0. update "doc/changelog.txt"
+0. update "doc/changelog.rst"
 
-1. update the release number in "doc/proot/manual.txt"
+1. update the release number in "doc/proot/manual.rst"
 
 2. regenerate the documentation: `make -C doc`
 

doc/proot/changelog.txt → doc/proot/changelog.rst

@@ -1,3 +1,13 @@
+=======================================================================
+=======================================================================
+
+  This file is no longer used for tracking changes for PRoot. For
+  user visible changes, please look in the top-level CHANGELOG.rst
+  file.
+
+=======================================================================
+=======================================================================
+
 Release v5.1.0
 ==============