Commits

Karl Rupp  committed b1b5fb1

readjusted title

  • Participants
  • Parent commits b0e4c5e

Comments (0)

Files changed (2)

File Creating a patch for PETSc using git.md

-# Creating a patch for PETSc using git
-
-### Clone the Repository
-If you haven't already, the first step is to obtain a recent copy of the PETSc repository:
-
-     $> git clone https://bitbucket.org/petsc/petsc.git
-     $> cd petsc/
-
-This creates a new folder 'petsc' containing the development repository and changes right into it.
-
-### Start Cleanly
-If all the changes you applied to the PETSc code should enter the patch, proceed to the next section.
-
-Otherwise, if you have already cloned the repository at some earlier stage and played around with it, but you don't want to keep any of your changes to files, reset the current work tree using
-
-     $:petsc> git checkout -f
-
-To selectively bring files back to their original state, first run
-
-     $:petsc> git status
-
-to get a list of modified files. For each file `f` to be reverted, issue
-
-     $:petsc> git checkout path/to/f
-
-
-### Branch From Master
-Create a new branch with a name of your choice (avoid spaces), e.g. `myFeature1` by
-
-     $:petsc> git checkout -b myFeature1
-
-Note that creating a branch is a natural work flow with git. Any bad experiences you had with older version control systems do not apply here.
-
-
-### Apply your Changes
-If you haven't already, apply all the changes to the sources which should go into the patch. Please try to make a patch self-contained, dealing with only one aspect or module at a time (for example: Fixes to documentation).
-
-
-### Commit your Changes
-Once you completed updating the source tree, let's first check a summary of changed files:
-
-      $:petsc> git status
-
-If all the files shown as 'modified' should indeed be patched, commit you work using
-
-      $:petsc> git commit -am "Your commit message here"
-
-On the other hand, if you want to cherry-pick the files you want to include in the patch specify them via:
-
-      $:petsc> git add path/to/file1 path/to/file2
-
-and commit them using
-
-      $:petsc> git commit -m "Your commit message here"
-
-### Create the patch
-You can commit multiple times to the same branch before creating a patch. Once your changes are completed, the changes with respect to master need to be extracted. To write the patch to a file `myFeature1.patch`, use
-
-      $:petsc> git format-patch master --stdout > myFeature1.patch
-
-Note: If you wish to instead create one patch file per commit in your new branch myFeature1, use
-
-      $:petsc> git format-patch master
-
-Your patch files will then be enumerated and start with `0001-`, `0002-`, etc.
-
-
-### Send it over
-Please send the newly created patch file(s) to [petsc-dev@mcs.anl.gov](mailto:petsc-dev@mcs.anl.gov)

File patch-instructions-git.md

+# Creating a patch for PETSc using git
+
+### Clone the Repository
+If you haven't already, the first step is to obtain a recent copy of the PETSc repository:
+
+     $> git clone https://bitbucket.org/petsc/petsc.git
+     $> cd petsc/
+
+This creates a new folder 'petsc' containing the development repository and changes right into it.
+
+### Start Cleanly
+If all the changes you applied to the PETSc code should enter the patch, proceed to the next section.
+
+Otherwise, if you have already cloned the repository at some earlier stage and played around with it, but you don't want to keep any of your changes to files, reset the current work tree using
+
+     $:petsc> git checkout -f
+
+To selectively bring files back to their original state, first run
+
+     $:petsc> git status
+
+to get a list of modified files. For each file `f` to be reverted, issue
+
+     $:petsc> git checkout path/to/f
+
+
+### Branch From Master
+Create a new branch with a name of your choice (avoid spaces), e.g. `myFeature1` by
+
+     $:petsc> git checkout -b myFeature1
+
+Note that creating a branch is a natural work flow with git. Any bad experiences you had with older version control systems do not apply here.
+
+
+### Apply your Changes
+If you haven't already, apply all the changes to the sources which should go into the patch. Please try to make a patch self-contained, dealing with only one aspect or module at a time (for example: Fixes to documentation).
+
+
+### Commit your Changes
+Once you completed updating the source tree, let's first check a summary of changed files:
+
+      $:petsc> git status
+
+If all the files shown as 'modified' should indeed be patched, commit you work using
+
+      $:petsc> git commit -am "Your commit message here"
+
+On the other hand, if you want to cherry-pick the files you want to include in the patch specify them via:
+
+      $:petsc> git add path/to/file1 path/to/file2
+
+and commit them using
+
+      $:petsc> git commit -m "Your commit message here"
+
+### Create the patch
+You can commit multiple times to the same branch before creating a patch. Once your changes are completed, the changes with respect to master need to be extracted. To write the patch to a file `myFeature1.patch`, use
+
+      $:petsc> git format-patch master --stdout > myFeature1.patch
+
+Note: If you wish to instead create one patch file per commit in your new branch myFeature1, use
+
+      $:petsc> git format-patch master
+
+Your patch files will then be enumerated and start with `0001-`, `0002-`, etc.
+
+
+### Send it over
+Please send the newly created patch file(s) to [petsc-dev@mcs.anl.gov](mailto:petsc-dev@mcs.anl.gov)