# HG changeset patch # User Steve Losh # Date 1278784624 14400 # Node ID ff965bcaa2af9b2373259d41c510dc6cdc711332 # Parent 8b81f9393b01ab6dd7ad989c74a50931c2b3fb36 hg-review: Update documentation. diff -r 8b81f9393b01 -r ff965bcaa2af hg-review/_sources/concepts.txt --- a/hg-review/_sources/concepts.txt Mon Jul 05 23:59:30 2010 -0400 +++ b/hg-review/_sources/concepts.txt Sat Jul 10 13:57:04 2010 -0400 @@ -5,11 +5,11 @@ Your code is not perfect. -If you're the only person that's reading your code, it's wrong. Period. +If you're the only person that's reading your code, it's wrong. As developers we need to review each other's code. This helps us catch errors before they find our users. It also makes us take greater care when writing -code because we know someone will most definitely be looking at it. +code because we know someone will be looking at it. Code Review Basics ------------------ @@ -60,7 +60,7 @@ them. In the past half-decade or so there has been a move toward *decentralized* or -*distrubuted* version control systems. With these systems you commit to your +*distributed* version control systems. With these systems you commit to your local machine and then *push* and *pull* your commits to other people. Code review tools, however, seem to have remained rooted in the "centralized diff -r 8b81f9393b01 -r ff965bcaa2af hg-review/_static/review.css --- a/hg-review/_static/review.css Mon Jul 05 23:59:30 2010 -0400 +++ b/hg-review/_static/review.css Sat Jul 10 13:57:04 2010 -0400 @@ -3,6 +3,7 @@ background-color: #f8f7e8; font-family: Georgia, serif; color: #222; + text-rendering: optimizeLegibility; } body a, html a { color: #b6410c; @@ -94,25 +95,11 @@ line-height: 24px; white-space: pre; } -.document .documentwrapper .bodywrapper ul { - list-style-type: disc; -} -.document .documentwrapper .bodywrapper ul li { - margin-left: 44px; -} .document .documentwrapper .bodywrapper ul span.pre { background-color: inherit; border: none; padding: 0; } -.document .documentwrapper .bodywrapper ul li.toctree-l1 { - list-style-type: none; - margin-left: 0; -} -.document .documentwrapper .bodywrapper ul li.toctree-l2, .document .documentwrapper .bodywrapper ul li.toctree-l3 { - list-style-type: none; - margin-left: 30px; -} .document .documentwrapper .bodywrapper a em { font-style: normal; } diff -r 8b81f9393b01 -r ff965bcaa2af hg-review/_static/review.less --- a/hg-review/_static/review.less Mon Jul 05 23:59:30 2010 -0400 +++ b/hg-review/_static/review.less Sat Jul 10 13:57:04 2010 -0400 @@ -96,11 +96,24 @@ white-space: pre; } ul { + list-style-type: disc; + + li { + margin-left: 44px; + } span.pre { background-color: inherit; border: none; padding: 0; } + li.toctree-l1 { + list-style-type: none; + margin-left: 0; + } + li.toctree-l2, li.toctree-l3 { + list-style-type: none; + margin-left: 30px; + } } a em { font-style: normal; diff -r 8b81f9393b01 -r ff965bcaa2af hg-review/concepts.html --- a/hg-review/concepts.html Mon Jul 05 23:59:30 2010 -0400 +++ b/hg-review/concepts.html Sat Jul 10 13:57:04 2010 -0400 @@ -49,10 +49,10 @@

Concepts

You’re not perfect.

Your code is not perfect.

-

If you’re the only person that’s reading your code, it’s wrong. Period.

+

If you’re the only person that’s reading your code, it’s wrong.

As developers we need to review each other’s code. This helps us catch errors before they find our users. It also makes us take greater care when writing -code because we know someone will most definitely be looking at it.

+code because we know someone will be looking at it.

Code Review Basics

The simplest form of code review is asking a friend to look at the code you @@ -92,7 +92,7 @@ your project. You would push changes to this central server and it would store them.

In the past half-decade or so there has been a move toward decentralized or -distrubuted version control systems. With these systems you commit to your +distributed version control systems. With these systems you commit to your local machine and then push and pull your commits to other people.

Code review tools, however, seem to have remained rooted in the “centralized server” approach. Even the tools that support decentralized version control diff -r 8b81f9393b01 -r ff965bcaa2af hg-review/searchindex.js --- a/hg-review/searchindex.js Mon Jul 05 23:59:30 2010 -0400 +++ b/hg-review/searchindex.js Sat Jul 10 13:57:04 2010 -0400 @@ -1,1 +1,1 @@ -Search.setIndex({desctypes:{},terms:{all:[2,5,1,4],concept:[0,5,2],mile:5,follow:1,hate:[],decid:1,depend:[2,4],flask:2,init:[0,4,1,2],program:[7,5],under:7,sourc:2,fals:[1,4],faq:7,offlin:5,failur:1,affect:7,relev:4,disturb:[],level:1,did:5,list:[1,5],"try":5,item:1,stderr:1,gut:5,quick:2,pleas:2,prevent:4,natur:5,sign:[1,5],past:5,second:5,design:4,pass:1,port:[1,4],even:[4,5],index:[],what:[0,1,4],poke:0,section:4,abl:4,remain:5,current:[1,4],delet:[],version:[2,7,5],"new":[2,1,4],hgreview:[2,1],ever:4,"public":[2,1,4],can:[2,5,1,4],full:[1,5],never:[4,5],here:0,let:[2,4,5],address:[1,4],locat:2,valu:1,search:[],sjl:[0,4,2],action:[],opinion:5,chang:[1,5],chanc:[4,5],although:4,extra:4,backout:5,appli:5,modul:[],brought:[],filenam:1,api:[0,3],visibl:4,instal:[0,4,2],from:[1,5],describ:1,would:[1,5],visit:[2,1,4],two:[1,5],next:2,few:[2,4,5],live:[1,4],recommend:5,decentr:5,type:5,tell:5,more:[0,5,1,4],peopl:[4,5],site_root:4,train:[],particular:5,hold:[2,1],easiest:2,none:1,someproject:2,sometim:4,car:[],work:[2,7,5],histori:5,anon_us:4,whatev:5,learn:[0,7],purpos:5,root:5,fetch:4,control:5,distrubut:5,quickstart:0,share:[],indic:1,topic:1,want:[0,7,4,1,2],alwai:[5,1,4],goal:5,turn:5,anoth:5,read_onli:4,how:[2,7,4,5],anyon:[2,4],instead:[5,1,4],simpl:[0,5],perman:4,product:5,subcommand:1,clone:[0,4,1,2],befor:[4,5],wrong:[4,5],plane:[],embrac:5,mai:[],data:[0,1,2,3,4,5],"short":1,practic:5,bind:4,caus:4,inform:4,combin:4,allow:[1,4],order:1,talk:5,help:[1,5],over:2,move:5,approv:5,becaus:[4,5],top:5,held:5,comma:1,left:4,mainli:1,perfect:5,write:5,fix:5,better:5,solitari:[],window:[],restart:4,commmit:1,decad:5,main:4,might:[2,7,5],easier:5,them:[2,4,5],good:1,"return":1,greater:5,thei:5,python:[0,3,2],initi:[0,4,1,2],jinja2:2,half:5,now:[0,4,2],choic:[0,1],somewher:[0,2],name:4,anyth:[0,5],edit:[0,5,1,4],gerrit:5,separ:[1,5],easili:4,mode:4,each:[1,5],debug:1,updat:4,mean:[1,5],replac:1,individu:1,idea:5,realli:5,contrib:4,someth:[2,4],our:5,out:[0,5],shown:1,accomplish:5,goe:5,rev:1,content:1,print:1,got:[0,4],gunicorn:4,insid:5,given:1,ask:5,org:[0,4,2],care:[4,5],launch:[],could:[4,5],keep:[4,5],thing:[2,1,5],perhap:5,place:0,isn:5,think:[1,5],first:[0,5,4,1,2],mdown:1,onc:[2,4],number:1,yourself:1,hook:4,alreadi:[0,1,2],done:[2,4],least:1,open:[0,1,2],primari:5,ont:[],gpl:7,differ:[1,5],script:[1,4],interact:5,gpg:5,mkdir:4,system:5,messag:1,mercuri:[0,1,2,4,5,7],attach:1,store:5,listen:4,luckili:0,option:[1,4],especi:5,tool:[0,5],copi:4,specifi:1,biggest:5,part:4,exactli:[1,5],than:[0,5],serv:4,cron:4,kind:[4,5],provid:[5,1,4],structur:[0,5],provic:[],project:[2,5,1,4],matter:2,friend:5,were:5,toward:5,browser:[0,1,2],sai:5,viewer:4,modern:1,ani:[2,5,7,1,4],myproject:4,have:[2,5,1,4],tabl:[],need:[0,5,4,1,2],seen:[1,5],seem:[4,5],built:4,also:[2,1,5],without:[2,4,5],take:[4,5],noth:1,sure:2,distribut:[0,7,4,5],deploy:[0,4],track:5,licens:[0,7],glog:[],most:[5,1,4],plai:0,deploi:4,model:5,don:[2,5,1,4],url:[2,1],later:[2,7,5],doe:[1,5],latest:4,review:[0,1,2,4,5,6,7],changeset:[2,5,1,4],wsgi:4,signoff:[0,5,1,4],show:1,text:[],verbos:1,hack:[0,6],find:[1,5],impact:5,yoursit:4,onli:[2,5,1,4],layout:[0,6],configur:4,behind:5,should:[2,5,7,1,4],local:[0,5,4,2],get:[2,1],stop:1,bear:[],autom:4,repo:[2,4],made:4,report:[0,2],neither:1,requir:[2,1],enabl:[0,1],remot:[2,1,5],bad:1,integr:0,contain:5,grab:4,where:[1,4],wrote:5,view:[1,4],set:[2,5,1,4],see:[2,4],num:1,manag:5,fail:1,expertis:5,statu:1,hgrc:[0,4,2],state:1,won:[4,5],simplest:5,"import":4,awai:[0,5],experi:5,approach:5,parent:[],disallow:1,extens:[0,4,1,2],job:4,both:2,howev:5,quiet:1,tour:2,instanc:4,context:1,com:4,comment:[0,5,1,4],markdown:1,simpli:[4,5],point:4,overview:[0,2],period:5,path:[0,4,1,2],diff:1,guid:0,reviewboard:5,code:[0,5,4,1,2],coupl:2,been:5,mark:1,interpret:[],basic:[0,5],immedi:4,oth:[],fire:[2,4],thousand:5,atlassian:5,understand:5,"catch":5,impati:0,those:1,crucibl:5,look:[7,4,5],"while":[2,5],unifi:1,error:[2,1,5],anonym:[1,4],advantag:5,ctrl:1,readi:[0,2],canon:1,worri:2,itself:[0,7,5],clutter:[2,5],uncom:4,conf:4,revis:1,sever:[1,5],develop:[0,5],welcom:[],author:[4,5],perform:[0,1],suggest:2,make:[2,1,5],anon:[1,4],same:[5,7,1,4],document:[0,6,2],conflict:4,http:[0,4,1,2],webserv:4,yese:1,someon:[5,1,4],hand:5,user:[0,4,5],task:1,off:1,whole:[1,5],well:[2,4],person:5,exampl:[2,4],command:[0,4,1,2],thi:[0,1,2,4,5,7],programm:[],everyth:4,usual:[],identifi:1,just:[2,5],when:[0,5,1,4],collabor:[1,5],web:[0,4,1,2],easi:5,had:5,except:1,littl:5,add:[0,4,1,2],els:[1,5],useless:5,applic:0,around:[0,5],format:[0,1,3],read:[2,5,1,4],know:[0,5,2],insert:4,like:[2,5,1,4],specif:[1,5],changelog:2,manual:4,server:[0,4,5],necessari:[4,5],popular:5,output:1,page:7,encount:[2,4],www:4,right:[0,1],often:5,some:[0,5,1,4],back:[4,5],intern:5,sampl:4,home:[],avoid:5,though:5,definit:5,usernam:[1,4],localhost:[0,4,1,2],refer:4,machin:5,creatur:[],run:[0,4,1,2],power:5,usag:[0,1,2],sacrif:5,host:2,repositori:[0,1,2,3,4,5],post:2,src:[2,5],about:[2,7,5],central:5,unfortun:5,commit:[2,1,5],own:[0,1,5],pythonpath:4,within:5,automat:4,down:[2,4],ensur:1,subvers:5,your:[0,5,4,1,2],merg:4,git:5,lof:[],log:5,wai:[2,5],support:5,editor:1,start:[0,5,4,1,2],reli:5,interfac:[0,4,1,2],includ:[4,5],lot:5,"var":4,hei:5,"function":5,head:4,form:5,forc:[],bundl:2,neutral:[1,5],yourproject:[4,5],gain:1,line:[0,5,4,1,2],inlin:1,"true":4,bug:[0,2],pull:[2,5,1,4],rietveld:5,possibl:[1,5],whether:1,access:[2,4],allow_anon_com:4,displai:1,below:[1,4],otherwis:1,problem:[2,4,5],creat:[2,5,7,1,4],year:5,doesn:[4,5],exist:[2,5],file:[0,1,2,3,4,5],check:[0,1,2],probabl:[2,1,4],echo:4,googl:[],titl:4,tip:[],detail:1,"default":[1,4],other:[0,5,4,1,2],normal:[4,5],test:[0,6,1],you:[0,1,2,4,5,7],nice:4,meaning:[],ago:5,bitbucket:[0,4,2],receiv:4,directori:[0,5,4,2],time:[2,1],push:[5,1,4]},titles:["hg-review documentation","Command Line Interface","Overview","API","Web Interface","Concepts","Hacking hg-review","Licensing"],modules:{},descrefs:{},filenames:["index","cli","overview","dev","webui","concepts","hacking","licensing"]}) \ No newline at end of file +Search.setIndex({desctypes:{},terms:{all:[2,5,1,4],concept:[0,5,2],mile:5,follow:1,hate:[],decid:1,depend:[2,4],flask:2,init:[0,4,1,2],program:[7,5],under:7,sourc:2,fals:[1,4],faq:7,offlin:5,failur:1,affect:7,relev:4,disturb:[],level:1,did:5,list:[1,5],"try":5,item:1,stderr:1,gut:5,quick:2,pleas:2,prevent:4,natur:5,sign:[1,5],past:5,second:5,design:4,pass:1,port:[1,4],even:[4,5],index:[],what:[0,1,4],poke:0,section:4,abl:4,remain:5,current:[1,4],delet:[],version:[2,7,5],"new":[2,1,4],hgreview:[2,1],ever:4,"public":[2,1,4],can:[2,5,1,4],full:[1,5],never:[4,5],here:0,let:[2,4,5],address:[1,4],layout:[0,6],valu:1,search:[],sjl:[0,4,2],action:[],opinion:5,chang:[1,5],chanc:[4,5],repositori:[0,1,2,3,4,5],extra:4,backout:5,appli:5,modul:[],brought:[],filenam:1,api:[0,3],visibl:4,instal:[0,4,2],yourself:1,from:[1,5],describ:1,would:[1,5],visit:[2,1,4],two:[1,5],next:2,few:[2,4,5],live:[1,4],recommend:5,decentr:5,type:5,tell:5,more:[0,5,1,4],peopl:[4,5],site_root:4,train:[],particular:5,hold:[2,1],easiest:2,none:1,someproject:2,left:4,car:[],work:[2,7,5],histori:5,anon_us:4,whatev:5,learn:[0,7],purpos:5,root:5,fetch:4,control:5,distrubut:[],quickstart:0,share:[],indic:1,topic:1,want:[0,7,4,1,2],unfortun:5,alwai:[5,1,4],goal:5,thing:[2,1,5],anoth:5,write:5,how:[2,7,4,5],anyon:[2,4],instead:[5,1,4],simpl:[0,5],perman:4,product:5,subcommand:1,clone:[0,4,1,2],befor:[4,5],wrong:[4,5],plane:[],embrac:5,mai:[],data:[0,1,2,3,4,5],"short":1,practic:5,bind:4,caus:4,inform:4,combin:4,allow:[1,4],order:1,talk:5,help:[1,5],over:2,move:5,approv:5,becaus:[4,5],top:5,held:5,comma:1,hgrc:[0,4,2],mainli:1,perfect:5,read_onli:4,fix:5,better:5,solitari:[],window:[],restart:4,commmit:1,decad:5,main:4,might:[2,7,5],easier:5,them:[2,4,5],good:1,"return":1,greater:5,thei:5,python:[0,3,2],initi:[0,4,1,2],jinja2:2,half:5,now:[0,4,2],choic:[0,1],somewher:[0,2],name:4,anyth:[0,5],edit:[0,5,1,4],gerrit:5,separ:[1,5],easili:4,mode:4,each:[1,5],debug:1,updat:4,mean:[1,5],replac:1,individu:1,idea:5,realli:5,ensur:1,year:5,our:5,out:[0,5],shown:1,accomplish:5,goe:5,rev:1,content:1,print:1,got:[0,4],gunicorn:4,insid:5,given:1,ask:5,org:[0,4,2],care:[4,5],launch:[],could:[4,5],keep:[4,5],turn:5,perhap:5,place:0,isn:5,think:[1,5],first:[0,5,4,1,2],mdown:1,onc:[2,4],number:1,sometim:4,hook:4,alreadi:[0,1,2],done:[2,4],least:1,open:[0,1,2],primari:5,ont:[],gpl:7,differ:[1,5],script:[1,4],interact:5,gpg:5,mkdir:4,system:5,messag:1,mercuri:[0,1,2,4,5,7],attach:1,store:5,listen:4,luckili:0,option:[1,4],especi:5,tool:[0,5],copi:4,specifi:1,"var":4,part:4,exactli:[1,5],than:[0,5],serv:4,cron:4,kind:[4,5],provid:[5,1,4],structur:[0,5],provic:[],project:[2,5,1,4],matter:2,friend:5,were:5,toward:5,browser:[0,1,2],sai:5,viewer:4,modern:1,ani:[2,5,7,1,4],myproject:4,have:[2,5,1,4],tabl:[],need:[0,5,4,1,2],seen:[1,5],seem:[4,5],built:4,also:[2,1,5],exampl:[2,4],take:[4,5],noth:1,sure:2,distribut:[0,7,4,5],deploy:[0,4],track:5,licens:[0,7],glog:[],most:[5,1,4],plai:0,deploi:4,everyth:4,don:[2,5,1,4],url:[2,1],later:[2,7,5],doe:[1,5],latest:4,someth:[2,4],changeset:[2,5,1,4],wsgi:4,signoff:[0,5,1,4],show:1,text:[],verbos:1,hack:[0,6],find:[1,5],impact:5,yoursit:4,onli:[2,5,1,4],locat:2,configur:4,state:1,should:[2,5,7,1,4],local:[0,5,4,2],get:[2,1],stop:1,bear:[],autom:4,repo:[2,4],rietveld:5,report:[0,2],awai:[0,5],requir:[2,1],enabl:[0,1],remot:[2,1,5],bad:1,integr:0,contain:5,grab:4,where:[1,4],wrote:5,view:[1,4],set:[2,5,1,4],see:[2,4],num:1,fail:1,expertis:5,statu:1,review:[0,1,2,4,5,6,7],behind:5,won:[4,5],simplest:5,"import":4,neither:1,experi:5,approach:5,parent:[],disallow:1,extens:[0,4,1,2],job:4,both:2,howev:5,quiet:1,tour:2,instanc:4,context:1,com:4,comment:[0,5,1,4],markdown:1,simpli:[4,5],point:4,overview:[0,2],period:[],path:[0,4,1,2],diff:1,guid:0,reviewboard:5,code:[0,5,4,1,2],coupl:2,been:5,mark:1,interpret:[],basic:[0,5],immedi:4,oth:[],fire:[2,4],thousand:5,atlassian:5,understand:5,"catch":5,impati:0,those:1,crucibl:5,look:[7,4,5],"while":[2,5],unifi:1,error:[2,1,5],anonym:[1,4],advantag:5,ctrl:1,readi:[0,2],canon:1,worri:2,itself:[0,7,5],clutter:[2,5],uncom:4,conf:4,revis:1,sever:[1,5],develop:[0,5],welcom:[],author:[4,5],perform:[0,1],suggest:2,make:[2,1,5],anon:[1,4],same:[5,7,1,4],document:[0,6,2],conflict:4,http:[0,4,1,2],webserv:4,yese:1,someon:[5,1,4],hand:5,user:[0,4,5],task:1,off:1,whole:[1,5],well:[2,4],person:5,without:[2,4,5],command:[0,4,1,2],thi:[0,1,2,4,5,7],programm:[],model:5,usual:[],identifi:1,just:[2,5],tip:[],collabor:[1,5],web:[0,4,1,2],easi:5,had:5,except:1,littl:5,add:[0,4,1,2],els:[1,5],useless:5,applic:0,around:[0,5],format:[0,1,3],read:[2,5,1,4],know:[0,5,2],insert:4,like:[2,5,1,4],specif:[1,5],changelog:2,manual:4,server:[0,4,5],necessari:[4,5],popular:5,output:1,page:7,encount:[2,4],www:4,right:[0,1],often:5,some:[0,5,1,4],back:[4,5],intern:5,sampl:4,home:[],avoid:5,though:5,definit:[],usernam:[1,4],localhost:[0,4,1,2],refer:4,machin:5,creatur:[],run:[0,4,1,2],power:5,usag:[0,1,2],sacrif:5,host:2,although:4,post:2,src:[2,5],about:[2,7,5],central:5,manag:5,includ:[4,5],commit:[2,1,5],own:[0,1,5],pythonpath:4,within:5,automat:4,down:[2,4],contrib:4,subvers:5,your:[0,5,4,1,2],merg:4,git:5,lof:[],log:5,wai:[2,5],support:5,start:[0,5,4,1,2],reli:5,interfac:[0,4,1,2],editor:1,lot:5,biggest:5,hei:5,"function":5,head:4,form:5,forc:[],bundl:2,neutral:[1,5],yourproject:[4,5],gain:1,line:[0,5,4,1,2],inlin:1,"true":4,bug:[0,2],pull:[2,5,1,4],made:4,possibl:[1,5],whether:1,access:[2,4],allow_anon_com:4,displai:1,below:[1,4],otherwis:1,problem:[2,4,5],creat:[2,5,7,1,4],doesn:[4,5],exist:[2,5],file:[0,1,2,3,4,5],check:[0,1,2],probabl:[2,1,4],echo:4,googl:[],titl:4,when:[0,5,1,4],detail:1,"default":[1,4],other:[0,5,4,1,2],normal:[4,5],test:[0,6,1],you:[0,1,2,4,5,7],nice:4,meaning:[],ago:5,bitbucket:[0,4,2],receiv:4,directori:[0,5,4,2],time:[2,1],push:[5,1,4]},titles:["hg-review documentation","Command Line Interface","Overview","API","Web Interface","Concepts","Hacking hg-review","Licensing"],modules:{},descrefs:{},filenames:["index","cli","overview","dev","webui","concepts","hacking","licensing"]}) \ No newline at end of file