Ext4 Contributing

From Ext4
(Difference between revisions)
Jump to: navigation, search
(e2fsprogs)
(e2fsprogs)
Line 5: Line 5:
 
= e2fsprogs =
 
= e2fsprogs =
  
1. Clone the e2fsprogs git repo (git://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git)
+
# Clone the e2fsprogs git repo (git://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git)
1. Make your code modifications as you see fit.
+
# Make your code modifications as you see fit.
1. Write some functional tests (see tests/ for examples) if you're writing new code.
+
# Write some functional tests (see tests/ for examples) if you're writing new code.
1. Static analysis, part 1: Run <code>make gcc-wall-new</code> to compile with all GCC warnings enabled.
+
# Static analysis, part 1: Run <code>make gcc-wall-new</code> to compile with all GCC warnings enabled.
1. Static analysis, part 2: Run <code>make clean; make C=1</code> to check your code against sparse.
+
# Static analysis, part 2: Run <code>make clean; make C=1</code> to check your code against sparse.
1. Regression tests: Run <code>cd tests/; make test_script; ./test_script --valgrind-leakcheck</code> to look for memory leaks.
+
# Regression tests: Run <code>cd tests/; make test_script; ./test_script --valgrind-leakcheck</code> to look for memory leaks.
1. When writing up your patches, please follow the guidelines in https://www.kernel.org/doc/Documentation/SubmittingPatches
+
# When writing up your patches, please follow the guidelines in https://www.kernel.org/doc/Documentation/SubmittingPatches
1. Send patches to the mailing list linux-ext4 at vger.kernel.org.
+
# Send patches to the mailing list linux-ext4 at vger.kernel.org.
  
 
While Eric Sandeen and Ted T'so occasionally upload code snapshots to Coverity as an additional checkpoint, these steps can be performed by any developer.
 
While Eric Sandeen and Ted T'so occasionally upload code snapshots to Coverity as an additional checkpoint, these steps can be performed by any developer.

Revision as of 18:13, 12 March 2014

Overview

This page summarizes the process of contributing code to the ext4 kernel driver or to e2fsprogs.

e2fsprogs

  1. Clone the e2fsprogs git repo (git://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git)
  2. Make your code modifications as you see fit.
  3. Write some functional tests (see tests/ for examples) if you're writing new code.
  4. Static analysis, part 1: Run make gcc-wall-new to compile with all GCC warnings enabled.
  5. Static analysis, part 2: Run make clean; make C=1 to check your code against sparse.
  6. Regression tests: Run cd tests/; make test_script; ./test_script --valgrind-leakcheck to look for memory leaks.
  7. When writing up your patches, please follow the guidelines in https://www.kernel.org/doc/Documentation/SubmittingPatches
  8. Send patches to the mailing list linux-ext4 at vger.kernel.org.

While Eric Sandeen and Ted T'so occasionally upload code snapshots to Coverity as an additional checkpoint, these steps can be performed by any developer.

ext4 kernel

1. Clone the kernel git repo (git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git)
1. https://www.kernel.org/doc/Documentation/SubmittingPatches
Personal tools