torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add_c_file: Improve script documentation

Browse Source 
Part of 32962.
This commit is contained in:
teor
2020-01-20 13:20:14 +10:00
parent 0418bc0cb2
commit 2c75d4a8d0
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/maint/add_c_file.py
+8 -4
View File
@@ -4,16 +4,20 @@
Add a C file with matching header to the Tor codebase. Creates
both files from templates, and adds them to the right include.am file.
This script takes paths relative to the top-level tor directory.
It creates files, and inserts them into include.am, also relative to
the top-level tor directory.
This script takes paths relative to the top-level tor directory. It
expects to be run from that directory.
This script creates files, and inserts them into include.am, also
relative to the top-level tor directory.
But the template content in those files is relative to tor's src
directory. (This script strips "src" from the paths used to create
templated comments and macros.)
This script expects posix paths, so it should be run with a python
where os.path is posixpath. (Rather than ntpath.)
where os.path is posixpath. (Rather than ntpath.) This probably means
Linux, macOS, or BSD, although it might work on Windows if your python
was compiled with mingw, MSYS, or cygwin.
Example usage: