sapling/lib/README.md

21 lines
791 B
Markdown
Raw Normal View History

2018-01-10 02:20:46 +03:00
lib
===
Any native code (C/C++/Rust) that Mercurial (either core or extensions)
depends on should go here. Python code, or native code that depends on
Python code (e.g. `#include <Python.h>` or `use cpython`) is disallowed.
2018-01-10 02:20:46 +03:00
As we start to convert more of Mercurial into Rust, and write new paths
entrirely in native code, we'll want to limit our dependency on Python, which is
why this barrier exists.
2018-01-10 02:20:46 +03:00
See also `hgext/extlib/README.md`, `mercurial/cext/README.mb`.
How do I choose between `lib` and `extlib` (and `cext`)?
--------------------------------------------------------
If your code is native and doesn't depend on Python (awesome!), it goes here.
Otherwise, put it in `hgext/extlib` (if it's only used by extensions) or
`mercurial/cext` (if it's used by extensions or core).