Add documentation, make minor code modifications, cleanup build infrastructure #1
Loading…
Reference in New Issue
No description provided.
Delete Branch "juliana/guile-termenv:documentation"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR is messier than I usually like, but I'll try to explain every logical set of changes.
First and simplest are the documentation additions. These are all in the commit "Add basic documentation". These should be uncontroversial.
The next set of changes of note are the code changes. These were already discussed, have been tested, and are in "Enable support for more varieties of hexcode strings" and "Make port arguments last and optional". They do as described.
The final set of changes are those in "Cleanup build infrastructure" and these warrant more explanation. Overall, the objective is to allow the project to be built and maintained primarily through Guix. Firstly, this commit removes the
AUTHORS
,ChangeLog
, andNEWS
files. These are rarely used in modern software projects as they are more-or-less eclipsed by a combination of git and release notes. Then, it removesbootstrap
because it is redundant to extant build steps with only the addition ofautoreconf -vif
. Using Guix allowsautoreconf -vif
to be trivially executed during build. Finally,build-aux
is removed. By addinghall build -x
as a part of the build process, we get build-aux for free; and we have to run that with the current directory layout anyway. As a trivial aside, the redundantguile-termenv
directory is deleted; everything it had to offer is covered bytermenv
instead.The upshot of the build system changes are that a typical build-and-test cycle looks like
guix shell --rebuild-cache -f guix.scm guile
. This builds the project, runs tests, and installs everything for usage in a single command. If more granular control is desired, one can useguix shell -Df guix.scm
, optionally with-C
or--pure
, to get a working environment. From there, code can be built with the combination of commandshall build -x
,autoreconf -vif
, and./configure
.Gah, my tab settings borked indentation on these files... Let me fix that up before merging so there's consistent indentation.
Ah that was just a mistake as I attempted to rename it from the default that Hall creates, but one file must have been missing/regenerated
I'm happy to merge this whenever good.