Changes between Version 7 and Version 8 of GCI/Documentation/DoxygenForBSPs

Timestamp:

11/05/18 17:38:51 (5 years ago)

Author:

Gedare Bloom

Comment:

--

GCI/Documentation/DoxygenForBSPs

@@ -97 +97 @@
 === Contributing Your Work ===
 
-You are expected to [wiki:Developer/Contributing provide a patch] for all the changes you make. Your task should be specific to a single BSP, so we would like you to use a commit message such as:
+You are expected to [wiki:Developer/Contributing provide a patch] for all the changes you make. Your task should be specific to a single BSP, so we would like you to use a commit command after modifying all the files with a commit message such as:
 {{{
 git commit -a -m "arm/raspberrypi: Update Doxygen (GCI 20xx)"
 }}}
 Where you would replace arm/raspberrypi by the arch/bsp you modified, and xx by the year of GCI this was done in. You are not required to use your real name and email address in the commit authorship information, but if you don't then you should use your GCI display name as a pseudonym.
+
+Your patch should apply cleanly (without whitespace warnings) to RTEMS using the `git-am` command. You may like to test your patch, for example, by
+{{{
+git format-patch HEAD^ -o ../doxygen/
+git checkout master
+git checkout -b test
+git am ../doxygen/0001-*.patch
+}}}
 
 ===  Notes, tips, tricks  ===