Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HACKING.md: describe testing #796

Merged
merged 1 commit into from
Mar 9, 2023
Merged

HACKING.md: describe testing #796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion HACKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ At its simplest, you build Augeas from git by running the following
commands in the toplevel directory of your Augeas checkout:

./autogen.sh [--gnulib-srcdir=$GNULIB_CHECKOUT]
make && make install
make && make check && make install

It is recommended though to turn on a few development features when
building; in particular, stricter compiler warnings and some debug
Expand All @@ -54,6 +54,12 @@ to augtool verbatim
* `./src/try valgrind`: run the commands from `build/augcmds.txt` through
augtool under valgrind to check for memory leaks

Furthermore, the test suite invoked with `make check` includes a test
called `test-get.sh`, which ensures that reading the files in
`tests/root/` with `augtool` does not lead to any errors. (It does not
verify the parsed syntax tree however; you'll have to extend the
individual lens tests under `lenses/tests/` for that.)

# Platform specific notes

## Mac OSX
Expand Down