llvm-project/lldb/docs
Raphael Isemann 4112f5ef69 [lldb][NFC] Specify guidelines for API tests
This patch specifies a few guidelines that our API tests should follow.

The motivations for this are twofold:

1. API tests have unexpected pitfalls that especially new contributors run into
when writing tests. To prevent the frustration of letting people figure those
pitfalls out by trial-and-error, let's just document them briefly in one place.

2. It prevents some arguing about what is the right way to write tests. I really
like to have fast and reliable API test suite, but I also don't want to be the
bogeyman that has to insist in every review that the test should be rewritten to
not launch a process for no good reason. It's much easier to just point to a
policy document.

I omitted some guidelines that I think could be controversial (e.g., the whole
"should assert message describe failure or success").

Reviewed By: shafik

Differential Revision: https://reviews.llvm.org/D101153
2021-05-17 11:01:47 +02:00
..
_lldb Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference 2021-01-17 12:13:01 +01:00
_static [lldb][docs] Expand CSS fix for LLDB doc tables 2021-01-20 10:30:00 +01:00
design [lldb] Remove references to LLDB_CAPTURE_REPRODUCER 2021-03-31 21:42:00 -07:00
man Fix typo, arvm7 -> armv7 2021-05-05 00:56:44 -04:00
resources [lldb][NFC] Specify guidelines for API tests 2021-05-17 11:01:47 +02:00
status [lldb] [docs] Update platform support status 2021-02-21 21:47:48 +01:00
testsuite [lldb][NFC] Delete a checked-in build log in docs/testsuite 2021-04-23 10:36:43 +02:00
use [lldb] Improve the documentation (#42017) 2021-04-08 10:58:02 -07:00
.htaccess [lldb][docs] Update .htaccess to redirect from old SB API documentation to new one 2021-01-19 18:58:43 +01:00
CMakeLists.txt Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference 2021-01-17 12:13:01 +01:00
conf.py [lldb] Fix the man page build 2021-03-11 19:51:47 +01:00
doxygen-mainpage.dox [Docs] Make Doxygen functional 2019-04-19 18:02:35 +00:00
doxygen.cfg.in [lldb] Fix typos in documentation (NFC) 2021-03-01 23:40:29 -08:00
index.rst [lldb] [docs] Update platform support status 2021-02-21 21:47:48 +01:00
lldb-for-gdb-users.txt [lldb] Fix typos in documentation (NFC) 2021-03-01 23:40:29 -08:00
lldb-gdb-remote.txt [trace][intel-pt] Implement trace start and trace stop 2021-03-30 17:31:37 -07:00
lldb-platform-packets.txt [lldb] Fix typos in documentation (NFC) 2021-03-01 23:40:29 -08:00
python_api.rst Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference 2021-01-17 12:13:01 +01:00
python_api_enums.rst [lldb] [gdb-remote server] Introduce new stop reasons for fork and vfork 2021-04-24 11:08:33 +02:00