hg-review documentation¶

hg-review is a Mercurial extension for performing -distributed code review.

Quickstart¶

If you’re impatient and want to play with hg-review right away, here’s what you @@ -59,15 +59,13 @@

Now you need a repository that has code review enabled. Luckily, you’ve already got one – hg-review uses itself for code review.

cd into the directory you cloned hg-review to and initialize the review -data:

+data, then start the web interface:

cd hg-review
-hg review --init

+hg review --init +hg review --web

Start the web interface:

hg review --web

Open http://localhost:8080/ in your browser of choice and poke around.

Check out the Overview when you’re ready to learn more.

Open http://localhost:8080/ in your browser of choice and poke around. Check +out the Overview when you’re ready to learn more.

User’s Guide¶

diff -r 75e16ecaa86d -r d3c735c94461 hg-review/licensing.html --- a/hg-review/licensing.html Tue Jun 15 20:00:45 2010 -0400 +++ b/hg-review/licensing.html Tue Jun 15 20:30:36 2010 -0400 @@ -43,6 +43,11 @@

Licensing¶

hg-review is distributed under the same license as Mercurial itself: GPL +version 2 or any later version.

If you want to create a program that works with hg-review you should look at +Mercurial’s License FAQ page to +learn about how this might affect you.

diff -r 75e16ecaa86d -r d3c735c94461 hg-review/overview.html --- a/hg-review/overview.html Tue Jun 15 20:00:45 2010 -0400 +++ b/hg-review/overview.html Tue Jun 15 20:30:36 2010 -0400 @@ -78,7 +78,7 @@ reviewing.

You should read over the concepts documentation to make sure you know how hg-review works, and the web interface -documentation for a quick tour of how to use the web ui.

+documentation for a quick tour of how to use the web UI.

Projects without Existing Code Reviews¶

@@ -93,7 +93,7 @@ project’s directory and run:

hg review --init --remote-path URL

The URL should be the URL of the review repo you just created.

The URL should be the public URL of the review repo you just created.

This will create a local review data repo for you, as well as an .hgreview file in your project. You need to commit this .hgreview file to your project with the command that hg-review suggested.

@@ -103,7 +103,7 @@ running hg review --web in your project.

You should read over the concepts documentation to make sure you know how hg-review works, and the web interface -documentation for a quick tour of how to use the web ui.

+documentation for a quick tour of how to use the web UI.

diff -r 75e16ecaa86d -r d3c735c94461 hg-review/searchindex.js --- a/hg-review/searchindex.js Tue Jun 15 20:00:45 2010 -0400 +++ b/hg-review/searchindex.js Tue Jun 15 20:30:36 2010 -0400 @@ -1,1 +1,1 @@ -Search.setIndex({desctypes:{},terms:{all:[2,5],concept:[0,5,2],mile:5,hate:[],depend:2,flask:2,init:[0,2],program:5,sourc:2,fals:4,offlin:5,disturb:[],did:5,list:5,"try":5,gut:5,quick:2,pleas:2,prevent:4,natur:5,sign:5,past:5,second:5,port:4,even:[4,5],index:[],what:[0,4],poke:0,section:4,abl:4,access:[2,4],version:[2,5],"new":2,hgreview:2,whatev:5,full:5,never:5,here:0,let:[2,4,5],address:4,layout:[0,6],search:[],sjl:[0,2],opinion:5,chang:5,chanc:5,extra:4,backout:5,appli:5,modul:[],brought:5,api:[0,3],instal:[0,2],from:5,would:5,visit:[2,4],two:5,next:2,few:[2,4,5],recommend:5,decentr:5,type:5,tell:5,more:[0,4,5],peopl:[4,5],train:5,particular:5,hold:2,easiest:2,car:5,work:[2,5],histori:5,remain:5,can:[2,4,5],learn:0,purpos:5,root:5,control:5,distrubut:5,quickstart:0,indic:[],want:[0,4,2],alwai:5,goal:5,thing:[2,5],anoth:5,write:5,how:[2,5],anyon:[2,4],instead:[4,5],simpl:[0,5],perman:4,product:5,clone:[0,2],befor:5,wrong:5,plane:5,embrac:5,data:[0,5,4,3,2],practic:5,bind:4,inform:4,combin:4,allow:4,talk:5,help:5,over:2,move:5,approv:5,becaus:[4,5],top:5,held:5,hgrc:[0,2],perfect:5,fix:5,better:5,solitari:[],decad:5,might:[2,5],easier:5,them:[2,4,5],greater:5,thei:5,python:[0,3,2],initi:[0,2],jinja2:2,half:5,now:[0,2],choic:0,somewher:[0,2],name:4,anyth:[0,5],edit:5,gerrit:5,separ:5,mode:4,each:5,mean:5,idea:5,realli:[2,5],year:5,our:5,out:[0,5],accomplish:5,goe:5,content:[],got:0,insid:5,ask:5,org:[0,2],care:[4,5],could:5,keep:5,turn:5,perhap:5,place:0,isn:5,think:5,first:[0,5,2],onc:2,alreadi:[0,2],done:2,open:[0,2],primari:5,ont:[],differ:5,interact:5,gpg:5,system:5,mercuri:[0,5,4,2],store:5,listen:4,luckili:0,option:4,especi:5,tool:[0,5],exactli:5,than:[0,5],kind:5,remot:[2,5],structur:[0,5],project:[2,5],matter:2,friend:5,were:5,toward:5,browser:[0,2],sai:5,viewer:4,ani:[2,5],have:[2,5],tabl:[],need:[0,5,2],seen:5,seem:5,also:[2,5],exampl:[2,4,5],useless:5,sure:2,distribut:[0,5],deploy:[0,4],track:5,licens:[0,7],most:[4,5],plai:0,deploi:4,don:[2,5],url:2,later:[2,5],doe:5,someth:2,changeset:[2,5],signoff:[0,5,1,4],hack:[0,6],find:5,impact:5,onli:[2,4,5],locat:2,should:[2,5],local:[0,5,4,2],get:2,bear:5,repo:2,rietveld:5,report:[0,2],requir:2,enabl:0,provid:[1,5],integr:0,contain:5,wrote:5,view:4,set:[2,4,5],see:[2,4],expertis:5,review:[0,1,2,4,5,6],behind:5,won:5,simplest:5,awai:[0,5],experi:5,approach:5,extens:[0,2],both:2,howev:5,tour:2,whole:5,comment:[0,5,1,4],simpli:5,overview:[0,2],period:5,path:[0,2],guid:0,reviewboard:5,code:[0,5,2],coupl:2,been:5,basic:[0,5],oth:[],fire:2,thousand:5,atlassian:5,understand:5,"catch":5,impati:0,crucibl:5,look:5,"while":[2,5],error:[2,5],anonym:4,advantag:5,readi:[0,2],worri:2,itself:[0,5],clutter:[2,5],sever:5,develop:[0,5],welcom:[],author:[4,5],perform:0,suggest:2,make:[2,5],anon:4,same:5,document:[0,6,2],http:[0,4,2],someon:5,hand:5,user:[0,5],com:4,well:2,person:5,without:[2,4,5],command:[0,4,1,2],thi:[0,5,4,2],programm:[],model:5,usual:[],just:[2,5],collabor:5,web:[0,4,1,2],easi:5,had:5,littl:5,add:[0,4,2],els:5,take:[4,5],applic:0,around:[0,5],format:[0,3],read:[2,4,5],know:[0,5,2],like:[2,5],specif:5,changelog:2,server:[0,4,5],necessari:5,popular:5,page:[],encount:2,right:0,often:5,some:[0,5],back:5,intern:5,home:[],avoid:5,though:5,definit:5,usernam:4,localhost:[0,4,2],machin:5,creatur:[],run:[0,4,2],power:5,usag:[0,2],sacrif:5,host:2,repositori:[0,5,4,3,2],post:2,src:5,about:[2,5],central:5,unfortun:5,commit:[2,5],own:[0,5],within:5,down:2,subvers:5,your:[0,5,4,2],manag:5,git:5,lof:[],log:5,wai:[2,5],support:5,start:[0,5,4,2],reli:5,interfac:[0,4,1,2],includ:5,lot:5,biggest:5,hei:5,"function":5,form:5,bundl:2,neutral:5,yourproject:5,line:[0,5,1,2],bug:[0,2],pull:[2,4,5],made:4,possibl:5,"default":4,problem:[2,5],creat:[2,5],doesn:5,exist:[2,5],file:[0,5,3,2],check:[0,1,2],probabl:[2,4],googl:[],titl:[],when:[0,4,5],other:[0,5,4,2],normal:[4,5],test:[0,6],you:[0,5,4,2],meaning:[],ago:5,bitbucket:[0,2],directori:[0,5,2],time:2,push:[4,5]},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],concept:[0,5,2],mile:5,hate:[],locat:2,depend:2,flask:2,init:[0,2],program:[7,5],under:7,sourc:2,fals:4,faq:7,offlin:5,affect:7,disturb:[],did:5,list:5,"try":5,gut:5,quick:2,pleas:2,prevent:4,natur:5,sign:5,past:5,second:5,port:4,even:[4,5],index:[],what:[0,4],poke:0,section:4,abl:4,access:[2,4],version:[2,7,5],"new":2,hgreview:2,"public":2,can:[2,4,5],full:5,never:5,here:0,let:[2,4,5],address:4,path:[0,2],search:[],sjl:[0,2],opinion:5,chang:5,chanc:5,extra:4,backout:5,appli:5,modul:[],brought:5,api:[0,3],instal:[0,2],from:5,would:5,visit:[2,4],two:5,next:2,few:[2,4,5],recommend:5,decentr:5,type:5,tell:5,more:[0,4,5],peopl:[4,5],train:5,particular:5,hold:2,easiest:2,car:5,work:[2,7,5],histori:5,remain:5,whatev:5,learn:[0,7],purpos:5,root:5,control:5,distrubut:5,quickstart:0,indic:[],want:[0,7,4,2],alwai:5,goal:5,turn:5,anoth:5,write:5,how:[2,7,5],anyon:[2,4],instead:[4,5],simpl:[0,5],isn:5,product:5,clone:[0,2],befor:5,wrong:5,plane:5,embrac:5,mai:[],data:[0,5,4,3,2],practic:5,bind:4,inform:4,combin:4,allow:4,talk:5,help:5,over:2,move:5,approv:5,becaus:[4,5],top:5,held:5,hgrc:[0,2],perfect:5,fix:5,better:5,solitari:[],decad:5,might:[2,7,5],easier:5,them:[2,4,5],greater:5,thei:5,python:[0,3,2],initi:[0,2],jinja2:2,half:5,now:[0,2],choic:0,somewher:[0,2],name:4,anyth:[0,5],edit:5,gerrit:5,separ:5,mode:4,each:5,mean:5,idea:5,realli:[2,5],year:5,our:5,out:[0,5],accomplish:5,goe:5,content:[],got:0,insid:5,ask:5,org:[0,2],care:[4,5],could:5,keep:5,thing:[2,5],perhap:5,place:0,perman:4,think:5,first:[0,5,2],onc:2,alreadi:[0,2],done:2,open:[0,2],primari:5,ont:[],gpl:7,differ:5,interact:5,gpg:5,system:5,mercuri:[0,5,7,4,2],store:5,listen:4,luckili:0,option:4,especi:5,tool:[0,5],exactli:5,than:[0,5],kind:5,provid:[1,5],structur:[0,5],project:[2,5],matter:2,friend:5,were:5,toward:5,browser:[0,2],sai:5,viewer:4,ani:[2,7,5],have:[2,5],tabl:[],need:[0,5,2],seen:5,seem:5,also:[2,5],exampl:[2,4,5],take:[4,5],sure:2,distribut:[0,7,5],though:5,usernam:4,licens:[0,7],most:[4,5],plai:0,deploi:4,don:[2,5],url:2,later:[2,7,5],doe:5,someth:2,changeset:[2,5],signoff:[0,5,1,4],hack:[0,6],find:5,impact:5,onli:[2,4,5],layout:[0,6],should:[2,7,5],local:[0,5,4,2],get:2,bear:5,repo:2,made:4,report:[0,2],requir:2,enabl:0,remot:[2,5],integr:0,contain:5,wrote:5,view:4,set:[2,4,5],see:[2,4],expertis:5,review:[0,1,2,4,5,6,7],behind:5,won:5,simplest:5,awai:[0,5],experi:5,approach:5,extens:[0,2],both:2,howev:5,anon:4,com:4,comment:[0,5,1,4],simpli:5,overview:[0,2],period:5,guid:0,reviewboard:5,code:[0,5,2],coupl:2,been:5,basic:[0,5],oth:[],fire:2,thousand:5,atlassian:5,understand:5,"catch":5,impati:0,crucibl:5,look:[7,5],"while":[2,5],error:[2,5],anonym:4,advantag:5,readi:[0,2],worri:2,itself:[0,7,5],clutter:[2,5],sever:5,develop:[0,5],welcom:[],author:[4,5],perform:0,suggest:2,make:[2,5],tour:2,same:[7,5],document:[0,6,2],http:[0,4,2],someon:5,hand:5,user:[0,5],whole:5,well:2,person:5,without:[2,4,5],command:[0,4,1,2],thi:[0,5,7,4,2],programm:[],model:5,usual:[],just:[2,5],when:[0,4,5],collabor:5,web:[0,4,1,2],easi:5,had:5,littl:5,add:[0,4,2],els:5,useless:5,applic:0,around:[0,5],format:[0,3],read:[2,4,5],know:[0,5,2],like:[2,5],specif:5,changelog:2,server:[0,4,5],necessari:5,popular:5,page:7,encount:2,right:0,often:5,some:[0,5],back:5,intern:5,home:[],avoid:5,deploy:[0,4],definit:5,track:5,localhost:[0,4,2],machin:5,creatur:[],run:[0,4,2],power:5,usag:[0,2],sacrif:5,host:2,repositori:[0,5,4,3,2],post:2,src:5,about:[2,7,5],central:5,unfortun:5,commit:[2,5],own:[0,5],within:5,down:2,subvers:5,your:[0,5,4,2],manag:5,git:5,lof:[],log:5,wai:[2,5],support:5,start:[0,5,4,2],reli:5,interfac:[0,4,1,2],includ:5,lot:5,biggest:5,hei:5,"function":5,form:5,bundl:2,neutral:5,yourproject:5,line:[0,5,1,2],bug:[0,2],pull:[2,4,5],rietveld:5,possibl:5,"default":4,problem:[2,5],creat:[2,7,5],doesn:5,exist:[2,5],file:[0,5,3,2],check:[0,1,2],probabl:[2,4],googl:[],titl:[],tip:[],other:[0,5,4,2],normal:[4,5],test:[0,6],you:[0,5,7,4,2],meaning:[],ago:5,bitbucket:[0,2],directori:[0,5,2],time:2,push:[4,5]},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