- setuptools aims to a build library instead of being invoked by setup.py.
Launching setup tools using ./setup.py is deprecated. Launching it using
generic build tools that use pyproject.toml is recommended.
- With the new approach customizing the build is not possible to the earlier
extent. So, introduce is a simple and sufficient build system using 'make'.
Tests:
- Check the pyproject.toml using validate-pyproject tool.
- Run diffoscope on old and new packages and verify that no unexpected changes
were introduced by the build system change.
- None of the files part of .deb package have different file permissions
compared to before.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Also fix a typo with target name.
- Remove redundant OUTPUT= declarations.
- Make sure that 'manual-pages' PHONY target is not attempted to be removed on
clean.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Fixes: #2173.
When a wget process fails to download an image from Debian wiki for any reason,
fail the whole fetching process so that the users notices it and reruns the
process. Earlier, these were failing silently leading to zero sized images.
Tests:
- Without the change, notice that when wget process is killed during fetching of
images, it leads to incorrect image files (partially downloaded or zero sized
files).
- With or without the changes, killing wget process at other times leads to
fetch process halting indicating that wget in normal cases fails correctly.
- With the change, killing the wget process will lead to an error and the
fetching process stops.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Make begin and end markers the default values in the wikiparser arguments so
that they don't have to passed in every time.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
- Also merge the way main xml is generated with individual xml page generation.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Fetch all pages included in manual
- Also fetch pages with + in name
- Generate raw xml from raw wiki files
- Don't fetch raw xml for manual pages
- Delete manual raw xml at end of fetch
- Iterate manual pages over raw wiki files instead of raw xml
- Skip remove-footer step for generated manual xml pages
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
[sunil: Don't remove intermediate targets during build]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
- When there are multiple binary packages, a common practice is to install into
debian/tmp using the Makefile and then use dh_install and .install files. This
splits the contents installed into debian/tmp to various package directories
debian/{package}.
- Install documentation in to /usr/share/freedombox instead of
/usr/share/doc/freedombox. Then create a link to /usr/share/doc/freedombox/.
This approach is recommended Debian Policy Manual in section 12.3[1] because
it should safe for administrator to delete files in /usr/share/doc safely
without breaking the application functionality. The doc-base must refer to the
documentation in /usr/share/doc as per doc-base documentation.
Links
1) https://www.debian.org/doc/debian-policy/ch-docs.html#additional-documentation
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
These files are not installed on the system and don't end up in the Debian
package. They pose not threat of causing a configuration file prompt.
Reviewed-by: Veiko Aasa <veiko17@disroot.org>
This is simply:
- Add es to languages list
- mkdir doc/manual/es
- make -C doc fetch
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Prevent unnecessary copying and shipping of .xml files.
- Run multiple jobs concurrently to speed up the process.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil@medhas.org Have common top level makefile for building manual]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Closes#930
- Make targets to download wiki pages of each service
- Add post-processor script for DocBook file processing
Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Already reorganised the manual page on the wiki for this purpose.
- Fix several issues with the Docbook export of MoinMoin.
- Replace / in title with a space.
- Remove revision history.
- Convert image dimensions to points from pixels.
- Fix incorrect wiki paths.
- Implement mechnism for downloading images and using them with
relative paths.
- Remove the old way of compiling the manual. Its contents are mostly
not applicable for end users. Design documents are outdated. INSTALL
and HACKING talk about Plinth installation not FreedomBox in general.
A fresh man page will be written later.
The generated TODO file is very limted in scope and gives a wrong
impression to a potential contributor. We have worked towards a central
TODO list for the entire project scrapping all other TODO lists.
Redirect the contributor to that list.
These cause lintain warning during Debian package building. They
currently don't serve any purpose as they are empty. They can be
re-added when they have some content.
Documentation shown inside Plinth is not effected by this as it includes
its own styling. Documentation that is opened by user directly from
/usr/share/doc/plinth is effected.
