Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add information about errors.dat to README_maintainers.md

This commit is contained in:
Max Neunhoeffer 2018-05-03 10:27:24 +02:00
parent 828f1d423c
commit 5e25199810
No known key found for this signature in database
GPG Key ID: 89A912AD5E343E1E
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README_maintainers.md
View File

@ -39,7 +39,23 @@ CMake flags
* *-DUSE_FAILURE_TESTS=1* - adds javascript hook to crash the server for data integrity tests
* *-DUSE_CATCH_TESTS=On (default is On so this is set unless you explicitly disable it)
If you have made changes to errors.dat, remember to use the -DUSE_MAINTAINER_MODE flag.
Errors in ArangoDB
------------------
If one changes any error in the ArangoDB system, then one has to:
1. Only touch `lib/Basics/errors.dat` and not the files which are
automatically generated from it (`lib/Basics/voc-errors.h`,
`lib/Basics/voc-errors.cpp` and `js/common/bootstrap/errors.js`)
2. Always do a full build with `USE_MAINTAINER_MODE` switched ON
afterwards, *before* you commit the change.
3. A `make arangod` is not enough! Since it will not recreate these
files!
*Reason*: These files are only built in maintainer mode, we want that a
build in non-maintainer-mode works from every commit.
If you only change the generated files, the next build with maintainer
mode will delete your changes.
CFLAGS
------