Newbie Guide for Windows People Working on Minor Bugs

From Dreamwidth Notes
Revision as of 12:26, 11 June 2010 by Livre d'Or (Talk | contribs)

Jump to: navigation, search
Note: I'm a newbie. I'm editing this as I'm learning new things or better ways to do what I know how to do. Feel free to suggest, correct, expand, add, anything that could make this better and clearer. ^_^


Install and Set Things Up

This may seem like a lot of things to do before you can really get started, things you're probably not familiar with but 1) you can do it 2) you'll only have to do this once.


Get a Dreamhack

What's a Dreamhack? To put it simply, it's an online mirror of the Dreamwidth site which is set up for any developer, beginner or experienced, who asks for it. This way, you don't have to go through the complicated process of installing the Dreamwidth code on your computer.

  • Apply for a Dreamhack by filling this form. The two important fields are 'Your Desired Username' and 'Your email address'. Note that your username is the name you'll use to log in to your Dreamhack; it's not the name of your account over there so no need to agonize over it. ;) Your e-mail address is used to send you a welcome e-mail which contains important information as well as maintenance/issue alerts and reinstall e-mails if you need to reinstall so it does matter. Also, some people like having an e-mail account specifically devoted to development. It's up to you.
  • Once you're done, you should get an e-mail with your login username and a password. Don't lose it. Once you've gotten this e-mail, you need to install two programs to be able to manage your Dreamhack: PuTTY and WinSCP.


Install PuTTY

What for? PuTTY will allow you to start and stop your Dreamhack, update it when changes are made (either by you or other developers) and generate patches.

  • Download PuTTY - choose the 'Windows installer for everything except PuTTYtel' .exe file - and install it.
  • Run PuTTY. In the configuration window, enter "hack.dreamwidth.net" for the host name. Go to Connection/Data and enter the username/login given to you in the welcome e-mail. It should be something like dh-username.
  • Click on Open. If you get a pop-up message about a key, click Yes.
  • Enter the password given to you in the welcome e-mail when asked. Note that no characters are displayed and the cursor won't move. It's normal.
  • Change your password by typing: 
    passwd
  • And that's it for now. :)


Install WinSCP

What for? WinSCP will allow you to browse and edit your Dreamhack files.

  • Install WinSCP. During the installation, you may be asked about the mode you prefer: Commander and Explorer. Commander works like an FTP client: a partitioned window with your computer files on one side and the Dreamhack files on the other. Explorer will only display your Dreamhack files and works like Windows's Explorer. I prefer this mode because I don't need to access any files on my computer but choose what's best for you.
  • Use "hack.dreamwidth.net" for the host name. Enter your username and password (the new one!). Click on Save then on Login.


Set Up Your Dreamhack

Protect Your Config Files

  • Follow the steps outlined at Back Up Your Configs. This will make sure you always have clean copies of your config files in /config-backup.
Go to PuTTY and copy paste the code given to you in the box.
Go to PuTTY and copy paste the code given to you.
Go to WinSCP, to /dw/cvs/local/cvs/.
In the right-sided window, right-click and select New/File. Call it multicvs-private.conf. Type the code given to you in the second box then save.
Go back to PuTTY and copy/paste the code given to you in the third box.


Create Scripts for Routine Tasks

  • Create the dwu, dws and dwdb scripts as explained in Scripting. U is for update, S is for Synchronize, DB is for Database.
Go to WinSCP and create the three files in /bin (again by right-clicking) with the code given to you in the boxes. For dwu, use the code from the second box.
Go to PuTTY and make them executable using the chmod ugo+x command. The code you need to type is bolded and is above each box of code.


Manage Your System Account

  • Your default Dreamhack account is called system. Go to PuTTY and type this to set its password: 
    $LJHOME/bin/upgrading/make_system.pl


Get Rid of Invite Codes

  • Go to WinSCP, to /dw/cvs/local/etc/, and double-click on config.pl. Find $USE_ACCT_CODES = 1; and change 1 to 0. Save your file.
  • Go to PuTTY and type this to make the changes go live on your Dreamhack: 
cd $LJHOME
stop-apache
dws
dwdb
start-apache


Create a Bugzilla account

  • As [info]mark explained here, go to Name and Password and enter your name following this format: Name [:username]. 'Name' can be your real-like name, a nickname, your username or any name you want. You don't have to enter your real name if you don't want to.


Finish Setting Up Your Dreamhack

  • The final and last step is to create files and folders for patches.
  • In PuTTY, type this to create files and folders in ~/dw/cvs/dw-free/.hg/: 
cd $LJHOME/cvs/dw-free
hg qinit -c
  • In WinSCP, open ~/dw/cvs/dw-free/.hg/hgrc and add this: 
[ui]
username = username <username@gmail.com>
  • Change the second username to your Bugzilla name and the e-mail address to your Bugzilla adress. Save the file.
  • In PuTTY again, type this to create files and folders in ~/dw/cvs/dw-nonfree/.hg/: 
cd $LJHOME/cvs/dw-nonfree
hg qinit -c
  • In WinSCP, open ~/dw/cvs/dw-nonfree/.hg/hgrc and add this: 
[ui]
username = username <username@gmail.com>
  • Change the second username to your Bugzilla name and the e-mail address to your Bugzilla adress. Save the file.

How All of This Works

PuTTY, WinSCP or Bugzilla ?

  • You use PuTTY to update your Dreamhack code, make your changes go live on your Dreamhack, create patches and manage patches.
  • You use WinSCP to edit Dreamhack files.
  • You use Bugzilla to find bugs, file bugs, and upload patches.


Folders and Files You Work With

  • Your Dreamhack has two parts:
    • the live part (~/dw/*)
    • the repository part (~/dw/cvs/dw-free/* and ~/dw/cvs/dw-nonfree/*).
  • But you work with in the repositories: you edit repository files and you create patches in repository folders.


Updating Your Repository Code

  • Code is committed by developers all the time. You must regularly update your repositories by running the 'Update' script: 
cd $LJHOME
stop-apache
dwu
start-apache
  • Note that this won't update your Dreamhack. You need to make the changes go live with the next step:


Making Changes Go Live on Your Dreamhack

  • To do that, you use the 'Synchronize' and 'DataBase' scripts: 
cd $LJHOME
stop-apache
dws
dwdb
start-apache


Before You Fix Anything

Find or File a Bug

Some of these bugs won't appear to require 'minor' effort to you. It's normal. Try to find small bugs among them: minor modifications to be done on one of the site pages (text to be modified; elements to be added, removed or moved; elements to be hidden from some categories of users, etc.).
  • To file: make sure it's not already been filed using simple search or advanced search then use this form to file a new bug. Fill and edit the fields as needed and don't forget to enter your e-mail address in Assign To and set the status to Assigned if you want to fix it. It's also ok to file a bug you know you're not going to be able to fix.


Create a Patch

  • First make sure nobody's working on the files you want to edit. If there are already patches up for review/commit, you may need to first import and apply these patches to your Dreamhack to avoid conflicts. You can see patches up for commit by clicking here. You can also wait for them to be committed if you don't want to go to the trouble of importing other patches. There's no rush. :)
  • Open PuTTY and update everything by running the three scripts. You need to work with the latest code.
  • Go to dw-free by typing this: 
cd $LJHOME
tocvs f
  • If you need to go to dw-nonfree, type this instead: 
cd $LJHOME
tocvs n
  • Create a new patch by typing this (change NUMBER and PATCHNAME of course): 
hg qnew -g bugNUMBER_PATCHNAME.diff


Edit Files

Use WinSCP to open the file(s) you need to edit.

  • If you're working on site pages, you're working on .bml files. These are in ~dw/cvs/dw-free/htdocs/ or one of the subsequent folders. You'll see that their names correspond to the URLs of site pages. These files may use .pm modules/widgets which are in ~dw/cvs/dw-free/cgi-bin/DW/ or ~dw/cvs/dw-free/cgi-bin/LJ/.
  • For text strings which are not in ~dw/cvs/dw-free/htdocs/ .bml.text files, see ~dw/cvs/dw-free/bin/upgrading/en.dat.
  • For more specific searches, you can use the grep command: grep [option(s)] pattern [file(s)]

Interesting options:

-E: match using extended regular expressions

-F: match using fixed strings

-r: recursive

-i: case insensitive

-l: filename only

-n: add relative line number

Examples: 

grep -ri "find this text" * | more
This will search for "find this text" in all files. 
grep -rl print_entry $LJHOME/bin/upgrading/s2layers
This will search for files containing "print_entry" in the /s2layers folder.
  • If WinSCP is not using your favorite editor, go to View/Preferences/Editor. Click on Add/External Editor and Browse. At the end don't forget to click on Up to make it the default editor.


Test Your Changes on Your Dreamhack

  • In PuTTY, stop your Dreamhack: 
cd $LJHOME
stop-apache
  • Synchronize your live code and update your database: 
dws
dwdb
  • Start your Dreamhack again: 
start-apache
  • Go to your Dreamhack and test. Edit the files again in WinSCP if more changes are needed. Go through these steps again to test your new changes.


Upload Your Patch

Update & Save Your Patch

  • In PuTTY, go to dw-free or dw-nonfree (tocvs f, tocvs n)
  • Type this to update your patch file: 
hg qrefresh
  • Go to your patch directory in WinSCP (/.hg/patches) and save a copy of your patch on your computer.
Warning: Do not manually edit your patch. This may cause errors make your patch invalid. Edit your file again. Refresh your patch. Test again.


Upload Your Patch to Bugzilla

  • Log in onto Bugzilla and open your bug.
  • Click on 'Add an Attachment' to attach your patch. Add a description and check 'patch'. Set Flags/Commit and Flags/Review to ? then click on Commit.
  • Wait for someone to review and commit your patch. You're done. :)


Tips and Tricks

  • If your repositories won't update properly with dwu, you may need to go to dw-free/dw-nonfree and remove all your local changes with hg update -C then run dwu again.
  • If your live code won't sync with your repository code, it may be because the files you've edited got saved using your computer time and not distant time. As the system relies on timestamps to see which files need to be updated, updates won't happen if live files seem to be more recent than repo files. Quickest trick is to change your computer time, open and save your files again so they get a later timestamp, refresh your patch and sync again.
  • If there's something wrong with your patch queue (it says the patch is not in the series or you can't delete a patch) don't forget that you can start over: delete the patches folder with WinSCP and recreate it again in PuTTY using hg qinit -c.
  • To see what's string of text is used in a page append ?uselang=debug to the page URL.
  • As [info]denise explained here, you need to delete old text strings and create new ones when you edit .text files or en.dat instead of simply editing the text. If the change isn't critical - the string doesn't need to be renamed or the text change is minor - it's better to notify the site copy team so that text can be changed locally and the original file left alone.
  • If text you've modified doesn't appear on the site after a code push, append ?uselang=debug to make sure it's using the right string. If it is then it may be that things haven't been updated yet.

References

Retrieved from "http://wiki.dreamwidth.net/wiki/index.php?title=Newbie_Guide_for_Windows_People_Working_on_Minor_Bugs&oldid=8338"