Trusted, Bureaucrats
4,228
edits
Changes
m
Then we add the files git add lib/software/nmrpipe.py git commit commit message<source lang="text">Added nmrpipe into git</source> # To see the commit message git log # Or see last changes by git log -p Then we create the '''seriestabnmrpipe''' branch(because we edit nmrpipe.py), from where we will create the patch according to the differences of the '''sr''' branch. git co -b seriestab nmrpipe sr
Export both commit message and change to last commit to file
git log -p -1
git log -p -1 > nmrpipe2_log
Switch to the {{relax developer link}} template to remove dead Gna! links.
{{historical svn}}
{{caution|This article is out of date, please see the [[Git_svn|article on using git-svn]] for a more appropriate development strategy.}}
== Motivation ==
Subversion needs an online repository, to store each commits. Subsequent calls to '''svn diff > patch''' will generate the difference according to the last revision. Therefore the development at the moment, require to
== Initialization of git ==
Navigate to the root folder of the branch of relax, you want to develop. Initialize with: git initThen follow the this post [[Git_svn#relax_branches_at_github | relax_branches_at_github]]
=== Setup commit information ===
As an example, we can take the development of the NMRPipe SeriesTab reader: [https://gna.org/support/index.php?3043 sr #3043: Support for NMRPipe seriesTab format *.ser]
We are going to make a support request '''sr''' branch. [http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging See ref. on branching]. In this branch we add the files we would like to track for changes. Then we create a branch '''sr/seriestab''' from '''sr'''. We then track and create patches of the differences between '''sr/seriestab''' and '''sr'''.
Create the support request '''sr''' branch.
git br -a
=== Checking out a development branch ===
We add the change to be recorded
git add lib/software/nmrpipe.py
# OR use this, to add changes from all tracked files
git add -u
Then we commit
git commit
git log -p
Now create your [[Git_patch | git patch]], comparing to the sr branch git format-patch sr--stdout > nmrpipe.patch
=== Modification 2 ===
We add the change to be recorded
git add lib/software/nmrpipe.py
# OR use this, to add changes from all tracked files
git add -u
Then we commit
git commit
Now create your patches, comparing to the sr branch
git format-patch sr--stdout > nmrpipe2.patchThis should provide two you with a second patch files, with more commits.
=== Getting an overview ===
[http://git-scm.com/book/en/Git-Basics-Viewing-the-Commit-History This section is prepared from this site].
Using a GUI to Visualize History. If you like to use a more graphical tool to visualize your commit history, you may want to take a look at a Tcl/Tk program called gitk that is distributed with Git. Gitk is basically a visual git log tool, and it accepts nearly all the filtering options that git log does. Type gitk on the command line in your project.
gitk
To find out, how long we would like to go back, we use the log
git log
We would like change the commit message two commits ago with commit hash sha1 of ('''^^833b91e6064cc8175ad741757ada25edd52c2cce''') git rebase -i 833b91e6064cc8175ad741757ada25edd52c2cce~1 # Instead of 'sha1' you can use 'HEAD^^~N', where N is the number of commits before 'HEAD' git rebase -i HEAD~2 Now mark the ones you want to amend with reword '''r''' (replace pick). Now save and exit editor.<br>In the next editor, you can then write the new message. Save and exit editor. Now create your patch, comparing to the sr branch git format-patch sr --stdout > nmrpipe3.patch === Continuation ===You continue with this cycle. * Modify code* Track the change git add -A # To add changes u* Make a commit message git commit == Finishing up == === Complete test suite ===First we test if we pass the test we setup for ourself relax -s Peak_lists.test_read_peak_list_NMRPipe_seriesTab === Upload patches ===First delete all the previous made patches. rm -r *.patch Now create your patches, comparing to the sr branch git format-patch sr --stdout > nmrpipe.patch Then upload the [[git_patch|git patch]] to the [https://gna.org/support/?group=relax support tracker]. == Reviewing suggestions and modify commit ==There were a number of [http://article.gmane.org/gmane.science.nmr.relax.devel/4120 suggestions] to the patches from all tracked {{relax developer link|username=bugman|text=Edward}}. === Squash commits ===[http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html You can squash commits], which essentially take smaller commits and untracked filescombine them into larger ones. This can be useful if you’re are wrapping up the day’s work of code. Then you can also prepare a better commit message. First get an overview, over which commits should be squashed git logLet's say you wan't to squash the last 6 commits. Set HEAD~6+1. git commit rebase -C i HEAD # reuse ~7In the pop-up editor, for all the commit thatcommits who should be squashed, replace '''pick''' with '''s there''' or '''squash'''. Omit this option Do not change the '''pick''' for the first commit.Save and exit editor. Now compose a new commit message, which can be combined of the earlier commit messages. Comment out lines with "#" which should not be added.<source lang="text">Completed NMRPipe SeriesTab reader Progress sr #3043: (https://gna.org/support/index.php?3043) Support for NMRPipe seriesTab format *.ser Completed NMRPipe SeriesTab reader for assignment according to SPARKY format.Changes implemented according to: http://article.gmane.org/gmane.science.nmr.relax.devel/4120</source>Then we test if you want the changes passed our test relax -s Peak_lists.test_read_peak_list_NMRPipe_seriesTab === Changes to pipe_control.spectrum.read() ===The above test, showed that the reading function had to be adjusted. So now we create a new branch, which is based on the branch we last edited. Meaning we copy the content of the modified files. git co -b spectrum nmrpipe git diff --stat --color nmrpipe..spectrumThe last line, should show an empty line for "no changes". Now we change spectrum.py in read(), # NMRPipe SeriesTab, and add a commit message to each commit. === Finishing up ===Delete old patches rm *.patch First change that tooto the first branch we made changes is git co nmrpipe git format-patch sr --stdout > nmrpipe.patch git co spectrum git rebase format-patch nmrpipe --continuestdout > spectrum.patch
== See also ==