Difference between revisions of "Newbie Guide for Windows People Working on Minor Bugs"

From Dreamwidth Notes
Jump to: navigation, search
(Summary Part)
(Part #2)
Line 10: Line 10:
 
What's a Dreamhack? To put it simply, it's a mirror of the Dreamwidth site where you can test your changes.
 
What's a Dreamhack? To put it simply, it's a mirror of the Dreamwidth site where you can test your changes.
  
#Apply for a Dreamhack by [http://hack.dreamwidth.net/apply.shtml filling this form].
+
* Apply for a Dreamhack by [http://hack.dreamwidth.net/apply.shtml filling this form].
#Get [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html 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-xxx. You may also want to change the Window/Appearance, Window/Colours and Window/Selection settings. Once you're done, go back to Session. Select Default Settings and click on Save.
+
* Get [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] - choose the 'Windows installer for everything except PuTTYtel' .exe file - and install it.
#Click on Open. Click Yes on the pop-up message box.
+
 
#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.
+
* 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-xxx.
#Change your password by typing: <source lang="bash">passwd</source>
+
 
#On your Dreamhack, the default user is called 'system'. You need to set its password so you can access this account. Type: <source lang="bash">$LJHOME/bin/upgrading/make_system.pl</source>
+
You may also want to change the Window/Appearance, Window/Colours and Window/Selection settings.
#Once you're done type: <source lang="bash">start-apache</source>
+
 
#You can access your Dreamhack at [http://yourusername.hack.dreamwidth.net/ http://yourusername.hack.dreamwidth.net/] and log in as system. You may want to upgrade your account to a paid one by [http://www.ninetydegrees.hack.dreamwidth.net/admin/capedit going here].
+
Once you're done, go back to Session. Select Default Settings and click on Save.
 +
 
 +
* Click on Open. Click Yes on the pop-up message box.
 +
 
 +
* 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: <source lang="bash">passwd</source>
 +
 
 +
* On your Dreamhack, the default user is called 'system'. You need to set its password so you can access this account. Type: <source lang="bash">$LJHOME/bin/upgrading/make_system.pl</source>
 +
 
 +
* Once you're done type: <source lang="bash">start-apache</source>
 +
 
 +
* You can access your Dreamhack at [http://yourusername.hack.dreamwidth.net/ http://yourusername.hack.dreamwidth.net/] and log in as system. You may want to upgrade your account to a paid one by [http://www.ninetydegrees.hack.dreamwidth.net/admin/capedit going here].
  
 
== Install WinSCP ==
 
== Install WinSCP ==
Line 24: Line 36:
 
What for? WinSCP will allow you to see and manage the files of your Dreamhack. You'll use it to edit the theme/layout files.
 
What for? WinSCP will allow you to see and manage the files of your Dreamhack. You'll use it to edit the theme/layout files.
  
#Install [http://winscp.net/eng/download.php WinSCP]. I chose the Explorer mode because I don't need to access any files on my computer but choose what's best for you.
+
* Install [http://winscp.net/eng/download.php WinSCP]. I chose the Explorer 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. Click on Save then on Login.
+
 
 +
* Use "hack.dreamwidth.net" for the host name. Enter your username and password. Click on Save then on Login.
  
  
Line 32: Line 45:
 
Again?! Yes, you need to create some files that will make keeping your Dreamhack up-to-date easier.
 
Again?! Yes, you need to create some files that will make keeping your Dreamhack up-to-date easier.
  
#Follow the steps outlined at [[Dreamhack_getting_started#Back_up_your_configs|Back Up Your Configs]]. N.B. To create files, go to WinSCP, go to the right directory, right-click on New/File and edit.
+
* Follow the steps outlined at [[Dreamhack_getting_started#Back_up_your_configs|Back Up Your Configs]]. N.B. To create files, go to WinSCP, go to the right directory, right-click on New/File and edit.
#Also create the <em>dwu</em>, <em>dws</em> and <em>dwdb</em> scripts as explained in [[Dev_Maintenance#Scripting|Scripting]].
+
 
#In PuTTY, type this then Enter:
+
* Also create the <em>dwu</em>, <em>dws</em> and <em>dwdb</em> scripts as explained in [[Dev_Maintenance#Scripting|Scripting]].
 +
 
 +
* In PuTTY, type this then Enter:
 
<source lang="bash">cd $LJHOME/cvs/dw-free
 
<source lang="bash">cd $LJHOME/cvs/dw-free
 
hg qinit -c</source>
 
hg qinit -c</source>
Line 76: Line 91:
 
* To find bugs, file bugs, upload patches, you use Buzilla.
 
* To find bugs, file bugs, upload patches, you use Buzilla.
  
 +
 +
= Before You Fix Anything =
 +
 +
== Find or File a bug ==
 +
 +
* To find: [http://bugs.dwscoalition.org/query.cgi use general search] or [http://bugs.dwscoalition.org/buglist.cgi?cmdtype=runnamed&namedcmd=why-styles%20new stricter search ].
 +
 +
* To file: [http://bugs.dwscoalition.org/enter_bug.cgi?alias=&assigned_to=nobody%40dreamwidth.org&blocked=&bug_file_loc=http%3A%2F%2F&bug_severity=enhancement&bug_status=ASSIGNED&comment=&component=Style%20System&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&dependson=&description=&flag_type-1=X&flag_type-10=X&flag_type-11=X&flag_type-2=X&flag_type-3=X&flag_type-5=X&flag_type-7=X&form_name=enter_bug&keywords=&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=P5&product=Dreamwidth%20Development&qa_contact=denise%40dreamwidth.org&rep_platform=All&short_desc=&target_milestone=-undecided-&version=unspecified use this template]. Fill or edit the fields as needed and don't forget to change the e-mail address in Assign To.
 +
 +
 +
== Create a Patch ==
 +
 +
#In PuTTY, go to the patch directory by typing this then Enter:
 +
<source lang="bash">cd $LJHOME
 +
tocvs</source>
 +
 +
#Create a new patch by typing this then Enter:<source lang="batch">hg qnew -g bug#NUMBER_PATCHNAME.diff</source>
  
 
[[Category:Styles Development]]
 
[[Category:Styles Development]]

Revision as of 10:21, 29 October 2009

To Wikify: http://experiment.dreamwidth.org/9596.html

Installing and Settings Things Up

You'll only have to do this once.


Get a Dreamhack

What's a Dreamhack? To put it simply, it's a mirror of the Dreamwidth site where you can test your changes.

  • Get 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-xxx.

You may also want to change the Window/Appearance, Window/Colours and Window/Selection settings.

Once you're done, go back to Session. Select Default Settings and click on Save.

  • Click on Open. Click Yes on the pop-up message box.
  • 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
  • On your Dreamhack, the default user is called 'system'. You need to set its password so you can access this account. Type:
    $LJHOME/bin/upgrading/make_system.pl
  • Once you're done type:
    start-apache

Install WinSCP

What for? WinSCP will allow you to see and manage the files of your Dreamhack. You'll use it to edit the theme/layout files.

  • Install WinSCP. I chose the Explorer 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. Click on Save then on Login.


Set Up Your Dreamhack

Again?! Yes, you need to create some files that will make keeping your Dreamhack up-to-date easier.

  • Follow the steps outlined at Back Up Your Configs. N.B. To create files, go to WinSCP, go to the right directory, right-click on New/File and edit.
  • Also create the dwu, dws and dwdb scripts as explained in Scripting.
  • In PuTTY, type this then Enter:
cd $LJHOME/cvs/dw-free
hg qinit -c

This will create a directory where your patches will be put into: ~/dw/csv/dw-free/.hg/patches/

Do the same thing with dw-nonfree if you're working with non-free styles:

cd $LJHOME/cvs/dw-nonfree
hg qinit -c

The directory will be: ~/dw/csv/dw-nonfree/.hg/patches/

Create a Bugzilla account

Simply click here.


How All of This Works

  • Your Dreamhack has two parts:
    • the live part (~/dw/*)
    • two main repository parts (~/dw/cvs/dw-free/* and ~/dw/cvs/dw-nonfree/*).
  • But you edit files in the repository parts and you create patches in the repository parts.
  • To make the live part match the repository parts, you use 'synchronize':
    dws
  • You also use 'update database':
    dwdb
  • You mustn't forget to regularly update the repository parts by running 'update':
    dwu

Of course, you'll have to run dws and dwdb again after that. You'll do this often. :)

  • To edit files, you use WinSCP.
  • To create patches and update code, you use PuTTY.
  • To find bugs, file bugs, upload patches, you use Buzilla.


Before You Fix Anything

Find or File a bug

  • To file: use this template. Fill or edit the fields as needed and don't forget to change the e-mail address in Assign To.


Create a Patch

  1. In PuTTY, go to the patch directory by typing this then Enter:
cd $LJHOME
tocvs
  1. Create a new patch by typing this then Enter:

    Invalid language.

    You need to specify a language like this: <source lang="html4strict">...</source>

    Supported languages for syntax highlighting:

    4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript, actionscript3, ada, algol68, apache, applescript, apt_sources, arm, asm, asp, asymptote, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcl, dcpu16, dcs, delphi, diff, div, dos, dot, e, ecmascript, eiffel, email, epc, erlang, euphoria, f1, falcon, fo, fortran, freebasic, freeswitch, fsharp, gambas, gdb, genero, genie, gettext, glsl, gml, gnuplot, go, groovy, gwbasic, haskell, haxe, hicest, hq9plus, html4strict, html5, icon, idl, ini, inno, intercal, io, j, java, java5, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, ldif, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, mmix, modula2, modula3, mpasm, mxml, mysql, nagios, netrexx, newlisp, nsis, oberon2, objc, objeck, ocaml, ocaml-brief, octave, oobas, oorexx, oracle11, oracle8, oxygene, oz, parasail, parigp, pascal, pcre, per, perl, perl6, pf, php, php-brief, pic16, pike, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, pys60, python, q, qbasic, rails, rebol, reg, rexx, robots, rpmspec, rsplus, ruby, s2, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, spark, sparql, sql, stonescript, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, upc, urbi, uscript, vala, vb, vbnet, vedit, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic


    hg qnew -g bug#NUMBER_PATCHNAME.diff