Mirror of strace – the linux syscall tracer
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README-hacking 1.9KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. Requirements
  2. ============
  3. If you use a GIT version of strace source code, please refer to
  4. INSTALL-git.md file for building and installation instructions.
  5. No more ChangeLog file
  6. ======================
  7. Do not create or modify the ChangeLog files. Starting at 2009-07-09, the
  8. policy changed. Before, we would insert the exact same text (or worse,
  9. sometimes slightly differing) into both the ChangeLog file and the commit
  10. log. Now we put that information only in the commit log, and generate
  11. the top-level ChangeLog file from logs at "make dist" time. As such,
  12. there are strict requirements on the form of the commit log messages.
  13. Commit requirements
  14. ===================
  15. Each commit message should always start with a one-line summary, the second
  16. line should be blank, and the remaining lines are usually ChangeLog-style
  17. entries for all affected files, except the leading TABs which should
  18. be omitted.
  19. Changes must not introduce whitespace errors in git sense (trailing
  20. whitespace, spaces before tabs, spaces for indentation, blank lines
  21. at the end of file), this can be checked with the following command:
  22. git -c core.whitespace=space-before-tab,trailing-space diff-index \
  23. --check 4b825dc642cb6eb9a060e54bf8d69288fbee4904
  24. It is also preferred (but not required) that commit patches pass
  25. scripts/checkpatch.pl script from the Linux kernel[1], as currently established
  26. coding style quite closely resembles the one used in Linux kernel[2], with some
  27. exceptions.
  28. [1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl
  29. [2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/process/coding-style.rst
  30. Documentation
  31. =============
  32. All noteworthy changes should be mentioned in NEWS. All changes in strace
  33. command interface should be reflected in the man page. New options should
  34. be documented both in -h output and in the man page.