Tips and Suggestions has been created by Karan Singh Malhi (Sep 08, 2007).

Content:

Useful information for new committers

Commits

Here is an email from David Belvins explaining the things he keeps in mind during commits. Definitely worth a read:

I generally try never to reformat a file and make changes at the same time as it makes it impossible for anyone to see what I've changed. Needle in a haystack. I try to get the reformatting as its own commit before or after I change a file.

A lot of times I end up tweaking a bunch of little unrelated things while working on a bigger change. I tend to like to "clear them out" in separate commits as to isolate the big change in one commit. Sometimes I'm not so good at that and other times I'm really meticulous about it.

Include the JIRA number and title (if there is a jira). I try never to say "Fixed FOO-2543" all by itself. Reviewing the last 10 changes on a file is a super big PITA when all you see is numbers to other systems. I shoot for more or less "Fixed <issue-number> <issue-title> <how-did-i-fix-it>" Sometimes the "how did i fix it" part is obvious by the title, other times not. Sometimes I'm too tired and the wife is impatiently waiting for me to leave the computer

As far as jiras go, there doesn't have to be a jira for absolutely every commit – what's the point of that. I try to make sure there's a jira for anything we'd definitely want to see in the release notes. Sometimes I don't get the jira created till long after the change, towards release time when creating the release notes It's pretty easy to forget stuff that way though

As far as jira titles, I always try and make them short and succinct for the future release notes.

scp, ssh, and rsync examples for working with files and directories on people.apache.org

copying a file to apache from locahost
scp topsecret.tar.gz [EMAIL PROTECTED]:
scp index.html [EMAIL PROTECTED]:public_html/

copying a file from apache to localhost – reverse of the above
scp [EMAIL PROTECTED]:topsecret.tar.gz ./
scp [EMAIL PROTECTED]:public_html/index.html ./

copying directories
scp -r [EMAIL PROTECTED]:public_html ./
scp -r public_html [EMAIL PROTECTED]:

When the directory exists, better to rsync

pull a dir from apache
rsync -v -e ssh -lzrptog [EMAIL PROTECTED]:public_html ./
rsync -v -e ssh -lzrptog [EMAIL PROTECTED]:/home/kmalhi/public_html ./

the two above commands do the exact same thing

push the same dir to apache
rsync -v -e ssh -lzrptog ./public_html [EMAIL PROTECTED]:
rsync -v -e ssh -lzrptog ./public_html [EMAIL PROTECTED]:/home/kmalhi/

the two above commands do the exact same thing

sometimes useful to execute commands over ssh (piping works too)
ssh people.apache.org ls /home | tee home-dirs-on-apache.txt
echo -e 'Hello, me\n\nHow am I doing today?' | ssh
[EMAIL PROTECTED] mail -s 'Greetings' [EMAIL PROTECTED]

Reply via email to