# HG changeset patch # User Steve Losh # Date 1276646445 14400 # Node ID 75e16ecaa86dc77171f2b0e069ab5b37e2d70df3 # Parent 456713829f79fd8325f847c1f177472d1e8b5123 hg-review: Update documentation. diff -r 456713829f79 -r 75e16ecaa86d hg-review/_sources/concepts.txt --- a/hg-review/_sources/concepts.txt Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/_sources/concepts.txt Tue Jun 15 20:00:45 2010 -0400 @@ -112,7 +112,7 @@ This changeset doesn't really impact me, so I don't care. -or: +or perhaps: I've looked at this code but don't have the expertise to provide a useful opinion. diff -r 456713829f79 -r 75e16ecaa86d hg-review/_sources/index.txt --- a/hg-review/_sources/index.txt Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/_sources/index.txt Tue Jun 15 20:00:45 2010 -0400 @@ -66,4 +66,5 @@ dev hacking + licensing diff -r 456713829f79 -r 75e16ecaa86d hg-review/_sources/licensing.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/hg-review/_sources/licensing.txt Tue Jun 15 20:00:45 2010 -0400 @@ -0,0 +1,3 @@ +Licensing +========= + diff -r 456713829f79 -r 75e16ecaa86d hg-review/_sources/webui.txt --- a/hg-review/_sources/webui.txt Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/_sources/webui.txt Tue Jun 15 20:00:45 2010 -0400 @@ -1,11 +1,57 @@ Web Interface ============= - The web interface of hg-review is probably what you're going to use the most. -Local Use ---------- +Running Locally +--------------- + +To start the web interface for a local repository that you want to review you +can run ``hg review --web``. Visit http://localhost:8080/ to use it. + +When you add comments or signoffs hg-review will use your normal Mercurial +username as the author. + +This command can take a few extra options: + +``--address ADDRESS`` + The address to bind to. Use ``0.0.0.0`` if you want other people to be able + to access it. + + **Be careful!** Because the web interface uses your Mercurial username by + default, binding to ``0.0.0.0`` will let anyone add comments and signoffs + in your name! You'll probably want to use the ``--read-only`` option to + prevent this. + + Default: ``127.0.0.1`` + +``--port PORT`` + The port to listen on. + + Default: ``8080`` + +``--read-only`` + Run the server in read-only mode. This will not allow data to be pushed or + pulled, comments to be made or signoffs to be added. + + This can be useful when combined with ``--address`` to let other people + view the UI without letting them add comments in your name. + + Default: ``false`` + +``--allow-anon`` + Allow comments (not not signoffs) to be added even if ``--read-only`` is + used, and set the username to ``Anonymous `` instead + of your Mercurial username. + + This option is most useful when you're deploying a permanent web interface + to a server and want to allow anonymous viewers to add comments. See the + :ref:`deployment` section for more information. + + Default: ``false`` + + +.. _deployment: Deployment to a Server ---------------------- diff -r 456713829f79 -r 75e16ecaa86d hg-review/concepts.html --- a/hg-review/concepts.html Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/concepts.html Tue Jun 15 20:00:45 2010 -0400 @@ -133,7 +133,7 @@

Signoffs of “neutral” might mean:

This changeset doesn’t really impact me, so I don’t care.
-

or:

+

or perhaps:

I’ve looked at this code but don’t have the expertise to provide a useful opinion.
diff -r 456713829f79 -r 75e16ecaa86d hg-review/hacking.html --- a/hg-review/hacking.html Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/hacking.html Tue Jun 15 20:00:45 2010 -0400 @@ -20,6 +20,7 @@ + @@ -30,6 +31,9 @@ index
  • + next |
    • +
  • previous |
  • hg-review vpre-alpha documentation »
    • @@ -73,6 +77,9 @@

    Previous topic

    API

    +

    Next topic

    +

    Licensing

    This Page

  • Web Interface
    • @@ -120,6 +120,7 @@
  • Documentation
    • +
  • Licensing
    • diff -r 456713829f79 -r 75e16ecaa86d hg-review/licensing.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/hg-review/licensing.html Tue Jun 15 20:00:45 2010 -0400 @@ -0,0 +1,96 @@ + + + + + + + Licensing — hg-review vpre-alpha documentation + + + + + + + + + +
    +

    Navigation

    + +
    + +
    +
    +
    +
    + +
    +

    Licensing

    +
    + + +
    +
    +
    +
    +
    +

    Previous topic

    +

    Hacking hg-review

    +

    This Page

    + + + +
    +
    +
    +
    +
    +

    Navigation

    + +
    +
    + © Copyright 2010, Steve Losh. + Created using Sphinx 0.6.7. +
    + + \ No newline at end of file diff -r 456713829f79 -r 75e16ecaa86d hg-review/searchindex.js --- a/hg-review/searchindex.js Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/searchindex.js Tue Jun 15 20:00:45 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,offlin:5,disturb:[],did:5,list:5,"try":5,gut:5,quick:2,pleas:2,natur:5,sign:5,past:5,second:5,even:5,index:[],what:[0,4],poke:0,access:2,version:[2,5],"new":2,hgreview:2,whatev:5,full:5,never:5,here:0,let:[2,5],layout:[0,6],search:[],sjl:[0,2],opinion:5,chang:5,chanc:5,backout:5,appli:5,modul:[],brought:5,api:[0,3],instal:[0,2],from:5,would:5,visit:2,two:5,next:2,few:[2,5],recommend:5,decentr:5,type:5,tell:5,more:[0,5],peopl:5,train:5,particular:5,hold:2,easiest:2,car:5,work:[2,5],histori:5,remain:5,can:[2,5],learn:0,purpos:5,root:5,control:5,distrubut:5,quickstart:0,indic:[],want:[0,2],unfortun:5,alwai:5,goal:5,thing:[2,5],anoth:5,write:5,how:[2,5],anyon:2,instead:5,simpl:[0,5],product:5,clone:[0,2],befor:5,wrong:5,plane:5,embrac:5,data:[0,5,3,2],practic:5,talk:5,help:5,over:2,move:5,approv:5,becaus:5,top:5,held:5,perfect:5,fix:5,better:5,solitari:[],decad:5,might:[2,5],easier:5,them:[2,5],greater:5,thei:5,python:[0,3,2],initi:[0,2],jinja2:2,half:5,now:[0,2],choic:0,somewher:[0,2],anyth:[0,5],edit:5,gerrit:5,separ:5,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:5,could:5,keep:5,turn: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,2],store:5,luckili:0,especi:5,tool:[0,5],review:[0,1,2,4,5,6],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,ani:[2,5],have:[2,5],tabl:[],need:[0,5,2],seen:5,seem:5,also:[2,5],exampl:[2,5],useless:5,sure:2,distribut:[0,5],deploy:[0,4],track:5,most:[4,5],plai:0,don:[2,5],url:2,later:[2,5],doe:5,someth:2,changeset:[2,5],signoff:[0,1,5],hack:[0,6],find:5,impact:5,onli:[2,5],locat:2,should:[2,5],local:[0,5,4,2],get:2,bear:5,repo:2,report:[0,2],requir:2,enabl:0,provid:[1,5],integr:0,contain:5,wrote:5,set:[2,5],see:2,expertis:5,hgrc:[0,2],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,1,5],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],advantag:5,readi:[0,2],worri:2,itself:[0,5],clutter:[2,5],sever:5,develop:[0,5],welcom:[],author:5,perform:0,suggest:2,make:[2,5],same:5,document:[0,6,2],http:[0,2],someon:5,hand:5,user:[0,5],well:2,person:5,without:[2,5],command:[0,1,2],thi:[0,5,2],programm:[],model:5,usual:[],just:[2,5],collabor:5,web:[0,4,1,2],easi:5,had:5,littl:5,add:[0,2],els:5,take:5,applic:0,around:[0,5],format:[0,3],read:[2,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,localhost:[0,2],machin:5,creatur:[],run:2,power:5,usag:[0,2],sacrif:5,host:2,repositori:[0,5,3,2],post:2,src:5,about:[2,5],central:5,manag:5,commit:[2,5],own:[0,5],within:5,down:2,subvers:5,your:[0,5,2],git:5,lof:[],log:5,wai:[2,5],support:5,start:[0,5,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,5],rietveld:5,possibl:5,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,5],other:[0,5,2],normal:5,test:[0,6],you:[0,5,4,2],meaning:[],ago:5,bitbucket:[0,2],directori:[0,5,2],time:2,push:5},titles:["hg-review documentation","Command Line Interface","Overview","API","Web Interface","Concepts","Hacking hg-review"],modules:{},descrefs:{},filenames:["index","cli","overview","dev","webui","concepts","hacking"]}) \ No newline at end of file +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 diff -r 456713829f79 -r 75e16ecaa86d hg-review/webui.html --- a/hg-review/webui.html Tue Jun 15 00:21:13 2010 -0400 +++ b/hg-review/webui.html Tue Jun 15 20:00:45 2010 -0400 @@ -48,11 +48,47 @@

    Web Interface

    The web interface of hg-review is probably what you’re going to use the most.

    -
    -

    Local Use

    +
    +

    Running Locally

    +

    To start the web interface for a local repository that you want to review you +can run hg review --web. Visit http://localhost:8080/ to use it.

    +

    When you add comments or signoffs hg-review will use your normal Mercurial +username as the author.

    +

    This command can take a few extra options:

    +
    +
    --address ADDRESS
    +

    The address to bind to. Use 0.0.0.0 if you want other people to be able +to access it.

    +

    Be careful! Because the web interface uses your Mercurial username by +default, binding to 0.0.0.0 will let anyone add comments and signoffs +in your name! You’ll probably want to use the --read-only option to +prevent this.

    +

    Default: 127.0.0.1

    +
    +
    --port PORT
    +

    The port to listen on.

    +

    Default: 8080

    +
    +
    --read-only
    +

    Run the server in read-only mode. This will not allow data to be pushed or +pulled, comments to be made or signoffs to be added.

    +

    This can be useful when combined with --address to let other people +view the UI without letting them add comments in your name.

    +

    Default: false

    +
    +
    --allow-anon
    +

    Allow comments (not not signoffs) to be added even if --read-only is +used, and set the username to Anonymous <anonymous@example.com> instead +of your Mercurial username.

    +

    This option is most useful when you’re deploying a permanent web interface +to a server and want to allow anonymous viewers to add comments. See the +Deployment to a Server section for more information.

    +

    Default: false

    +
    +
    -

    Deployment to a Server

    +

    Deployment to a Server

    @@ -65,7 +101,7 @@

    Table Of Contents