[devhelp] hacking: document source code locations, and why those locations



commit 23f0a2a0d66fdeacbcf680f95d1815031416f6d7
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Aug 26 15:53:53 2019 +0200

    hacking: document source code locations, and why those locations
    
    Instead of src-lib/ and src-app/ or something like that.

 HACKING | 13 +++++++++++++
 1 file changed, 13 insertions(+)
---
diff --git a/HACKING b/HACKING
index f7cfc58a..f7fcf337 100644
--- a/HACKING
+++ b/HACKING
@@ -41,6 +41,19 @@ library as well). For more information see also [3].
 
 [3] https://swilmet.be/blog/2019/08/18/10-years-later/
 
+Source code locations
+---------------------
+
+The library (libdevhelp) is in the `devhelp/` directory so that an `#include`
+like the following works when compiling the code:\
+`#include <devhelp/[…].h>`
+
+The application is in `src/`. (Not `src-app/` or something like it). Rationale:
+it is planned to split the Git repository in two in the future, to separate the
+library from the application. When there will only be the application in a git
+repository, `src/` is the usual name. And historically all the source code (lib
+and app) was in `src/`.
+
 C code conventions
 ------------------
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]