2017-03-28 14:18:16 +02:00
|
|
|
# Security coding guide
|
2013-03-11 18:11:16 -04:00
|
|
|
|
2018-02-08 13:08:40 +01:00
|
|
|
This is Fedora secure coding guide.
|
2013-03-11 18:11:16 -04:00
|
|
|
|
2017-03-28 14:18:16 +02:00
|
|
|
The guide is present in HTML form (auto-generated from this
|
|
|
|
|
repository) at:
|
2013-09-19 17:07:03 +02:00
|
|
|
|
2017-03-28 14:18:16 +02:00
|
|
|
* http://redhat-sectech.gitlab.io/defensive-coding-guide
|
2013-03-11 18:11:16 -04:00
|
|
|
|
2017-03-28 14:18:16 +02:00
|
|
|
|
|
|
|
|
# Building HTML documentation
|
2013-03-11 18:11:16 -04:00
|
|
|
|
2018-02-08 13:08:40 +01:00
|
|
|
1. Type "make".
|
2013-03-11 18:11:16 -04:00
|
|
|
|
2018-02-08 13:08:40 +01:00
|
|
|
When you type "make", the code examples in src/ are compiled (mainly
|
|
|
|
|
to check for obvious syntax errors, but also for manual testing). If
|
|
|
|
|
you lack the necessary libraries, the code examples are still
|
|
|
|
|
included in the manual.
|
|
|
|
|
|
|
|
|
|
After this you need to run `asciibinder package` to produce the document.
|
2013-03-11 18:11:16 -04:00
|
|
|
|
|
|
|
|
|
2017-03-28 14:18:16 +02:00
|
|
|
# Dependencies
|
|
|
|
|
|
|
|
|
|
Building the manual pages needs the "publican" and the "publican-fedora"
|
2018-02-08 13:08:40 +01:00
|
|
|
packages.
|
