aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md8
-rw-r--r--doc/gitian-building.md1
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index ec6abda91e..a596ea0117 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -425,6 +425,14 @@ Source code organization
- *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time
+- Every `.cpp` and `.h` file should `#include` every header file it directly uses classes, functions or other
+ definitions from, even if those headers are already included indirectly through other headers. One exception
+ is that a `.cpp` file does not need to re-include the includes already included in its corresponding `.h` file.
+
+ - *Rationale*: Excluding headers because they are already indirectly included results in compilation
+ failures when those indirect dependencies change. Furthermore, it obscures what the real code
+ dependencies are.
+
- Don't import anything into the global namespace (`using namespace ...`). Use
fully specified types such as `std::string`.
diff --git a/doc/gitian-building.md b/doc/gitian-building.md
index c2f55b5796..9f9afaf04f 100644
--- a/doc/gitian-building.md
+++ b/doc/gitian-building.md
@@ -131,6 +131,7 @@ To select a different button, press `Tab`.
- Leave domain name empty.
![](gitian-building/debian_install_5_configure_the_network.png)
+![](gitian-building/debian_install_6_domain_name.png)
- Choose a root password and enter it twice (remember it for later)