DragonX/dragonx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update dev doc

Browse Source
This commit is contained in:
Duke Leto
2020-11-14 19:50:59 -05:00
parent bf9af6ace3
commit 697ed53c66
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
DEVELOPING.md
View File

@@ -4,26 +4,27 @@
Normal compiling is as simple as:
./zcutil/build.sh
./build.sh
To make it use as many CPU threads as you have:
./zcutil/build.sh -j$(nproc) # assumes linux
./zcutil/build.sh -j8 # use a fixed 8 threads, more portable
./build.sh -j$(nproc) # assumes linux
./build.sh -j8 # use a fixed 8 threads, more portable
## Good Hygiene
To avoid weirld build system issues, it's often good to run:
To avoid weird build system issues, it's often good to run:
make clean
*before* you switch Git branches. Otherwise, the new branches Makefiles
often are incompatible and `make clean` will be impossible, which can
sometimes introduce weird bugs or make compiling really annoying.
If `make clean` produces a compilation error, you just experienced it.
## Switching branches
Switching branches and doing partial compiles in Komodo/Hush source code
Switching branches and doing partial compiles in Hush source code
can introduce weird bugs, which are fixed by running `build.sh` again.
Additionally, it's a good idea to run `make clean` before you switch
between branches.
@@ -38,6 +39,10 @@ build system dependencies, and you must do a `make clean` first, or even
option is to re-clone the repo, which sometimes is the least work to fix
the problem.
Running `make` doesn't understand about dependency changes, such as Rust crates.
A simple C/C++ change can be tested with just `make` but if you change the version
of a dependency or something inside of Rust, you will need `build.sh` .
## Generating new unix man pages
Make sure that you have updated all version numbers in hushd and compiled, then
@@ -51,10 +56,11 @@ After successfully compiling Hush, you can generate a debian package of these bi
./zcutil/build-debian-package.sh
This command will not work on Mac OS X. Currently you cannot generate a Debian package
from operating systems other than Linux.
This command will not work on Mac OS X. Currently you cannot generate a Debian package
from operating systems other than Linux. Oh well.
## Updates to this document
If you think something else should be in this guide, please send your suggestions!
Gitea: https://git.hush.is/hush/hush3