deploy: c50cd3b198bcff21b7744f5df20b416225baacaa

_sources/configuration.rst.txt

@@ -21,7 +21,33 @@ self-explanatory.
 
 Each section corresponds with a snapper configuration. Add additional sections to add
 other snapper configurations to be snapshotted. By default, only the root configuration
-is snapshotted.
+is snapshotted. Additionally you can add a section named ``DEFAULT`` with options that
+apply to all snapper configurations unless overridden in a later section.
+
+Each section can have the following entries:
+
+**desc_limit** - integer; maximum length of description string before being truncated.
+Default: 72
+
+**important_packages** - list of strings; names of packages that if involved in a pacman
+transaction will add ``important=yes`` to the snapper userdata for the pair of
+snapshots. Default: []
+
+**important_commands** - list of strings; parent commands that will add
+``important=yes`` to the snapper userdata for the pair of snapshots. Default: []
+
+**pre_description** - string; description for the pre snapshot. Default: the parent
+command that called the pacman hook.
+
+**post_description** - string; description for the post snapshot. Default: space
+separated list of packages that were installed, upgraded, or removed.
+
+**snapshot** - boolean; whether or not to snapshot the configuration. Default: True for
+``root`` configuration; False otherwise.
+
+**userdata** - list of strings; key-value pairs that will be added to the userdata for
+the pair of snapshots. Default: []
+
 
 Environment Variables
 ---------------------

configuration.html

@@ -48,7 +48,24 @@ By default only the <code class="docutils literal notranslate"><span class="pre"
 self-explanatory.</p>
 <p>Each section corresponds with a snapper configuration. Add additional sections to add
 other snapper configurations to be snapshotted. By default, only the root configuration
-is snapshotted.</p>
+is snapshotted. Additionally you can add a section named <code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code> with options that
+apply to all snapper configurations unless overridden in a later section.</p>
+<p>Each section can have the following entries:</p>
+<p><strong>desc_limit</strong> - integer; maximum length of description string before being truncated.
+Default: 72</p>
+<p><strong>important_packages</strong> - list of strings; names of packages that if involved in a pacman
+transaction will add <code class="docutils literal notranslate"><span class="pre">important=yes</span></code> to the snapper userdata for the pair of
+snapshots. Default: []</p>
+<p><strong>important_commands</strong> - list of strings; parent commands that will add
+<code class="docutils literal notranslate"><span class="pre">important=yes</span></code> to the snapper userdata for the pair of snapshots. Default: []</p>
+<p><strong>pre_description</strong> - string; description for the pre snapshot. Default: the parent
+command that called the pacman hook.</p>
+<p><strong>post_description</strong> - string; description for the post snapshot. Default: space
+separated list of packages that were installed, upgraded, or removed.</p>
+<p><strong>snapshot</strong> - boolean; whether or not to snapshot the configuration. Default: True for
+<code class="docutils literal notranslate"><span class="pre">root</span></code> configuration; False otherwise.</p>
+<p><strong>userdata</strong> - list of strings; key-value pairs that will be added to the userdata for
+the pair of snapshots. Default: []</p>
 <div class="section" id="environment-variables">
 <h2>Environment Variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2>
 <p>To temporarily prevent snapshots from being performed for a single pacman

searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["configuration","examples","faq","index","installation","troubleshooting"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["configuration.rst","examples.rst","faq.rst","index.rst","installation.rst","troubleshooting.rst"],objects:{},objnames:{},objtypes:{},terms:{"100":1,"1033":1,"1034":1,"2016":1,"8535cef3f3c38ee69555bf67e4b5e45aa3b8c5c3":4,"default":[0,3,5],"final":4,"while":5,For:[0,4],That:5,The:[0,1,3,5],Then:[0,1,4],Use:2,abov:1,action:2,add:[0,2,5],addit:0,addition:3,after:[1,3,5],alia:3,all:[0,1],along:1,also:1,altern:4,ani:[0,3,5],apr:1,aur:3,automat:[2,3],avail:1,avzq:2,awk:2,back:[2,3],backup:2,bash:2,becaus:3,befor:[1,3],behavior:[2,5],being:[0,5],bin:[1,2],boot:2,bootbackup:2,breakag:3,btrf:2,call:3,can:[1,2,3,5],care:3,caus:3,cdt:1,chang:[1,3],check:1,chroot:3,command:[0,3],comment:0,commit:4,configur:[1,3,5],conflict:1,consid:5,continu:1,copi:0,correspond:0,creat:[1,3],databas:5,delet:[1,2],depend:[1,3],descript:[2,3],detail:3,diff:[1,5],directli:3,disk:1,doc:1,doe:[2,3],doesn:3,done:0,download:4,dure:[1,3],each:[0,1,3],easili:3,edit:0,editor:0,end:2,environ:3,error:1,etc:[0,1,5],exact:3,exampl:[0,3],exec:2,expect:5,explanatori:0,extrem:3,f7b28c61944fe30dabeeb0b01070bcc98c18bd66:4,faq:[1,3],favorit:0,featur:3,file:[0,1,5],filter:5,find:[2,3],fingerprint:4,follow:[1,2,5],found:1,fri:1,from:[0,3,5],get:3,give:5,given:1,gone:3,gpg:4,has:[3,5],have:[3,4],helper:3,here:1,hook:[1,2,3,5],how:[1,2,3],html:1,inform:5,ini:0,instal:[1,2,3],instruct:5,integr:1,its:5,kei:[1,4],kernel:2,keyr:1,latest:4,lib:2,like:[2,3],link:2,linux:2,list:[1,2],live:3,load:1,locat:0,lock:5,log:[1,3],longer:[1,2],look:1,mai:[0,3],make:[3,4],matter:3,mean:1,method:3,mib:1,modifi:1,modul:2,more:[3,5],most:[0,3],mount:3,nano:1,nanorc:1,need:[0,3],non:2,now:1,number:[1,3,4],old:2,onli:[0,5],opensus:3,oper:2,other:[0,5],output:[1,3],pac:[0,1,2,4,5],packag:[1,2,3,4],pacman:[0,1,2,3,4,5],part:2,partit:2,perform:[0,1,5],pgp:4,post:[1,3,5],posttransact:2,pre:[1,3,5],pretransact:2,prevent:0,previou:4,print:2,proce:1,procedur:3,process:1,properli:3,provid:3,python:0,reason:3,releas:4,remov:[2,3,5],resolv:1,resort:3,restor:5,revert:3,rnano:1,rollback:[1,3],root:[0,1,2,5],rsync:2,run:[1,4,5],same:1,screen:3,script:3,section:[0,5],see:[1,3,5],self:0,set:[0,3,5],setup:3,sever:3,share:1,she:3,should:0,sig:4,sign:4,signatur:4,similar:3,simpl:3,singl:0,size:1,snap:[0,1,2,4,5],snap_pac_skip:0,snaphot:5,snapper:[0,1,2,3,5],snapshot:[0,1,2,3,5],some:3,someth:2,space:1,specif:3,start:4,statu:[1,5],subvolum:3,sudo:0,suitabl:0,symbol:1,symlink:2,system:3,syu:0,tail:1,take:[3,5],taken:5,tar:4,tarbal:4,target:2,temporarili:0,thi:[1,2,3,5],thing:3,through:3,total:1,transact:[1,3],trigger:2,troubleshoot:3,truncat:1,type:2,unam:2,undo:[1,3],undochang:[1,3,5],upgrad:[2,3],usb:3,use:3,used:[1,3],user:[0,3],using:[3,4],usr:[1,2],variabl:3,verifi:4,version:4,via:0,wai:[1,3],want:3,well:3,what:1,when:[2,3,5],where:4,whether:3,which:[3,5],won:5,would:2,xtype:2,yast:3,yes:5,you:[0,1,2,3,4,5],your:[0,3]},titles:["Configuration","Example","FAQ","Welcome to snap-pac\u2019s documentation!","Installation","Troubleshooting"],titleterms:{configur:0,document:3,environ:0,exampl:1,faq:2,instal:4,pac:3,snap:3,troubleshoot:5,variabl:0,welcom:3}})
+Search.setIndex({docnames:["configuration","examples","faq","index","installation","troubleshooting"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["configuration.rst","examples.rst","faq.rst","index.rst","installation.rst","troubleshooting.rst"],objects:{},objnames:{},objtypes:{},terms:{"100":1,"1033":1,"1034":1,"2016":1,"8535cef3f3c38ee69555bf67e4b5e45aa3b8c5c3":4,"boolean":0,"default":[0,3,5],"final":4,"import":0,"true":0,"while":5,For:[0,4],That:5,The:[0,1,3,5],Then:[0,1,4],Use:2,abov:1,action:2,add:[0,2,5],added:0,addit:0,addition:[0,3],after:[1,3,5],alia:3,all:[0,1],along:1,also:1,altern:4,ani:[0,3,5],appli:0,apr:1,aur:3,automat:[2,3],avail:1,avzq:2,awk:2,back:[2,3],backup:2,bash:2,becaus:3,befor:[0,1,3],behavior:[2,5],being:[0,5],bin:[1,2],boot:2,bootbackup:2,breakag:3,btrf:2,call:[0,3],can:[0,1,2,3,5],care:3,caus:3,cdt:1,chang:[1,3],check:1,chroot:3,command:[0,3],comment:0,commit:4,configur:[1,3,5],conflict:1,consid:5,continu:1,copi:0,correspond:0,creat:[1,3],databas:5,delet:[1,2],depend:[1,3],desc_limit:0,descript:[0,2,3],detail:3,diff:[1,5],directli:3,disk:1,doc:1,doe:[2,3],doesn:3,done:0,download:4,dure:[1,3],each:[0,1,3],easili:3,edit:0,editor:0,end:2,entri:0,environ:3,error:1,etc:[0,1,5],exact:3,exampl:[0,3],exec:2,expect:5,explanatori:0,extrem:3,f7b28c61944fe30dabeeb0b01070bcc98c18bd66:4,fals:0,faq:[1,3],favorit:0,featur:3,file:[0,1,5],filter:5,find:[2,3],fingerprint:4,follow:[0,1,2,5],found:1,fri:1,from:[0,3,5],get:3,give:5,given:1,gone:3,gpg:4,has:[3,5],have:[0,3,4],helper:3,here:1,hook:[0,1,2,3,5],how:[1,2,3],html:1,important_command:0,important_packag:0,inform:5,ini:0,instal:[0,1,2,3],instruct:5,integ:0,integr:1,involv:0,its:5,kei:[0,1,4],kernel:2,keyr:1,later:0,latest:4,length:0,lib:2,like:[2,3],link:2,linux:2,list:[0,1,2],live:3,load:1,locat:0,lock:5,log:[1,3],longer:[1,2],look:1,mai:[0,3],make:[3,4],matter:3,maximum:0,mean:1,method:3,mib:1,modifi:1,modul:2,more:[3,5],most:[0,3],mount:3,name:0,nano:1,nanorc:1,need:[0,3],non:2,now:1,number:[1,3,4],old:2,onli:[0,5],opensus:3,oper:2,option:0,other:[0,5],otherwis:0,output:[1,3],overridden:0,pac:[0,1,2,4,5],packag:[0,1,2,3,4],pacman:[0,1,2,3,4,5],pair:0,parent:0,part:2,partit:2,perform:[0,1,5],pgp:4,post:[0,1,3,5],post_descript:0,posttransact:2,pre:[0,1,3,5],pre_descript:0,pretransact:2,prevent:0,previou:4,print:2,proce:1,procedur:3,process:1,properli:3,provid:3,python:0,reason:3,releas:4,remov:[0,2,3,5],resolv:1,resort:3,restor:5,revert:3,rnano:1,rollback:[1,3],root:[0,1,2,5],rsync:2,run:[1,4,5],same:1,screen:3,script:3,section:[0,5],see:[1,3,5],self:0,separ:0,set:[0,3,5],setup:3,sever:3,share:1,she:3,should:0,sig:4,sign:4,signatur:4,similar:3,simpl:3,singl:0,size:1,snap:[0,1,2,4,5],snap_pac_skip:0,snaphot:5,snapper:[0,1,2,3,5],snapshot:[0,1,2,3,5],some:3,someth:2,space:[0,1],specif:3,start:4,statu:[1,5],string:0,subvolum:3,sudo:0,suitabl:0,symbol:1,symlink:2,system:3,syu:0,tail:1,take:[3,5],taken:5,tar:4,tarbal:4,target:2,temporarili:0,thi:[1,2,3,5],thing:3,through:3,total:1,transact:[0,1,3],trigger:2,troubleshoot:3,truncat:[0,1],type:2,unam:2,undo:[1,3],undochang:[1,3,5],unless:0,upgrad:[0,2,3],usb:3,use:3,used:[1,3],user:[0,3],userdata:0,using:[3,4],usr:[1,2],valu:0,variabl:3,verifi:4,version:4,via:0,wai:[1,3],want:3,well:3,were:0,what:1,when:[2,3,5],where:4,whether:[0,3],which:[3,5],won:5,would:2,xtype:2,yast:3,yes:[0,5],you:[0,1,2,3,4,5],your:[0,3]},titles:["Configuration","Example","FAQ","Welcome to snap-pac\u2019s documentation!","Installation","Troubleshooting"],titleterms:{configur:0,document:3,environ:0,exampl:1,faq:2,instal:4,pac:3,snap:3,troubleshoot:5,variabl:0,welcom:3}})