Update build documentation

This commit is contained in:
root
2026-04-30 06:48:22 +00:00
parent 49ac41045b
commit 099316b662
17 changed files with 145 additions and 55 deletions
+8 -8
View File
@@ -25,7 +25,7 @@ git diff -U0 HEAD~1.. | ./contrib/devtools/clang-format-diff.py -p1 -i -v
copyright\_header.py
====================
Provides utilities for managing copyright headers of `The PIVX
Provides utilities for managing copyright headers of `The Agrarian
developers` in repository source files. It has three subcommands:
```
@@ -44,31 +44,31 @@ Specifying `verbose` will list the full filenames of files of each category.
copyright\_header.py update \<base\_directory\> [verbose]
---------------------------------------------------------
Updates all the copyright headers of `The PIVX developers` which were
Updates all the copyright headers of `The Agrarian developers` which were
changed in a year more recent than is listed. For example:
```
// Copyright (c) <firstYear>-<lastYear> The PIVX developers
// Copyright (c) <firstYear>-<lastYear> The Agrarian developers
```
will be updated to:
```
// Copyright (c) <firstYear>-<lastModifiedYear> The PIVX developers
// Copyright (c) <firstYear>-<lastModifiedYear> The Agrarian developers
```
where `<lastModifiedYear>` is obtained from the `git log` history.
This subcommand also handles copyright headers that have only a single year. In
those cases:
```
// Copyright (c) <year> The PIVX developers
// Copyright (c) <year> The Agrarian developers
```
will be updated to:
```
// Copyright (c) <year>-<lastModifiedYear> The PIVX developers
// Copyright (c) <year>-<lastModifiedYear> The Agrarian developers
```
where the update is appropriate.
copyright\_header.py insert \<file\>
------------------------------------
Inserts a copyright header for `The PIVX developers` at the top of the
Inserts a copyright header for `The Agrarian developers` at the top of the
file in either Python or C++ style as determined by the file extension. If the
file is a Python file and it has `#!` starting the first line, the header is
inserted in the line below it.
@@ -78,7 +78,7 @@ The copyright dates will be set to be `<year_introduced>-<current_year>` where
`<year_introduced>` is equal to `<current_year>`, it will be set as a single
year rather than two hyphenated years.
If the file already has a copyright for `The PIVX developers`, the
If the file already has a copyright for `The Agrarian developers`, the
script will exit.
gen-manpages.sh