n2n/doc
Hamish Coleman 80b33cd1a9
Basic C Code lint checker and shell checker (#859)
* Factor build packages out into a more maintainable list

* Create a location for scripts to live

* Provide a make target to return the source dir as close as reasonable to the original distributed state

* Add a code lint step, checking the coding style

* Change test harness as recommended by shellcheck

* Ensure we actually have the linter tool installed

* Use the correct directory for cmake to run the tests

* Adjust for the older uncrustify in the current github ubuntu-latest

* Make one file pass the linter

* Integrate the lint with the existing test workflow

* Add files with minimal changes needed to the linter

* Add more files with minimal changes needed to the linter

* Dont build binaries if we fail the lint test

* Update the phony targets with the lint steps

* Ensure the flake8 package is installed in the new lint workflow job

* Use the makefile to drive the packages needed to install for linting

* No need to add dependancies on lint, just rely on the workflow status to show failure

* Update the scripts dir README to reflect current assumptions

* Rename and briefly document the indent.sh script

* Fix the ignore to ignore the right Makefile

* Rename the test_harness script to make it clear it is a shell script

* Provide a master lint make target and add a shell script lint tool

* Elminate stray tabs

* Drop include/auth.h from linter - there are inconsistant results with function definitions when using the current uncrustify rules
2021-10-24 01:21:18 +05:45
..
Advanced.md simplified conf file parsing (#582) 2021-01-13 00:45:48 +05:45
Authentication.md added support for N2N_FEDERATION environment variable (#820) 2021-09-26 04:32:12 +05:45
Building.md added some cross-compiled binary outputs to the autobuild (#850) 2021-10-14 02:30:42 +05:45
Communities.md added support for COMMUNITY_NAME environment variable (#814) 2021-09-25 15:15:16 +05:45
ConfigurationFiles.md Major documentation improvements (#752) 2021-08-19 20:02:53 +05:45
Crypto.md Major documentation improvements (#752) 2021-08-19 20:02:53 +05:45
Faq.md Major documentation improvements (#752) 2021-08-19 20:02:53 +05:45
Federation.md added support for N2N_FEDERATION environment variable (#820) 2021-09-26 04:32:12 +05:45
Hacking.md Major documentation improvements (#752) 2021-08-19 20:02:53 +05:45
ManagementAPI.md JSON Reply Management API - feature parity with old management interfaces (#861) 2021-10-23 11:05:05 +05:45
n2n_gateway.sh Improve readme and add basic routing information 2019-06-21 01:27:43 +02:00
Routing.md Major documentation improvements (#752) 2021-08-19 20:02:53 +05:45
Scratchpad.md updated Scratchpad.md 2021-10-17 22:37:41 +05:45
Scripts.md Basic C Code lint checker and shell checker (#859) 2021-10-24 01:21:18 +05:45
TapConfiguration.md Major documentation improvements (#752) 2021-08-19 20:02:53 +05:45
TrafficRestrictions.md Add feature to drop or accept specific packet transmit over edge network interface by rules. (#489) 2020-11-10 16:35:05 +01:00