Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and Packaging improvements #13

Merged
merged 63 commits into from
Feb 22, 2024
Merged

Conversation

hamishcoleman
Copy link
Contributor

Lots of minor cleanups to make the documentation and man pages clearer and more consistant.

Major rewrite of the debian package building to make it significantly simpler (and hopefully closer to best practices)

A smaller reworking of the RPM package building with the same intent

Some command line option changes to bring things in line with how the daemons are usually used.

Debian package upstream versions can only have hyphens if there is a
debian revision component at the end.  Since our version number is
automatically calculated by the git describe command, it is known to be
correct - even if debian hates it - so append a debian revision
component
Avoid replicating commands by using the existing make target for
install.  Also start to move the spec file towards a somewhat more normal
rpm build environment (actually building the source now).  Finally,
remove as much of the configure magic as is simple to do.
In the lower "level" config dumps, we dont need as much distinctive
separation of the sections, so avoid adding them until we are also
adding some of the help texts
Since most people who will be running the processes in the background
will be doing this with some kind of process supervisor - which will be
assisted by the daemon not forking, we can make the default case
simpler.

This also has the helpful side effect of allowing the removal of one
more non-zero-default variable in the *_defaults() function.
Since we wish to use the git describe feature to create the versions,
and that generates versions with dashes, and debian has specific
requirements for versions that have dashes, we need to make the correct
version number show up in the debian changelog.

This is unfortunate, since it also means that we cannot call this
package "native", however consistently using the exact VCS description
is significantly more useful.
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 41.66667% with 21 lines in your changes are missing coverage. Please review.

Project coverage is 40.58%. Comparing base (b952ae7) to head (2da21a2).

Files Patch % Lines
src/conffile.c 46.87% 17 Missing ⚠️
apps/edge.c 0.00% 3 Missing ⚠️
apps/supernode.c 0.00% 1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #13      +/-   ##
==========================================
- Coverage   46.30%   40.58%   -5.72%     
==========================================
  Files          40       52      +12     
  Lines        6051     8961    +2910     
==========================================
+ Hits         2802     3637     +835     
- Misses       3249     5324    +2075     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hamishcoleman hamishcoleman merged commit 456a8c9 into n42n:main Feb 22, 2024
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants