Skip to content
Kazuhito Hagio edited this page May 13, 2021 · 9 revisions

https://crash-utility.github.io/


Contribution Guidelines

Basics

Writing patches

  • Keep backward-compatibility.

    The crash utility has to be able to read vmcores from old kernels. To determine which symbols/members are defined in the kernel, kernel_symbol_exists() function, MEMBER_EXISTS() macro, etc. can be used.

  • If you add offset/size/array_length to each table, they have to be appended to the end of the tables.

    This is to avoid breaking previously compiled extension modules. Also, please add them to dump_offset_table() (in arbitrarily order).

  • To allocate memory, use GETBUF/FREEBUF() usually.

  • We do not care about indents (spaces or tabs) strictly, but adjusting your code to surrounding codes is better.

  • Do make clean and make warn to check if there is no compilation warning.

  • Add your Signed-off-by: tag to the commit message.

Submitting patches

  • Submit your patch to the crash-utility mailing list because the list has much more watchers than GitHub. We usually do not accept Pull Requests from GitHub.

    And the list is members-only list, emails posted by non-member will be moderated by admins. Please subscribe to the list before posting.

  • Your patch needs 2 acks from the maintainers to accept.

Clone this wiki locally