From 1cf749431a94a537069c6131ded8d48168a859a3 Mon Sep 17 00:00:00 2001 From: Tomas Mlcoch Date: Mon, 3 Mar 2014 09:59:42 +0100 Subject: [PATCH] Update man pages --- doc/createrepo_c.8.gz | Bin 1636 -> 1891 bytes doc/mergerepo_c.8.gz | Bin 982 -> 1004 bytes doc/modifyrepo_c.8.gz | Bin 713 -> 781 bytes utils/gen_rst.py | 41 +++++++++++++++++++++++++---------------- 4 files changed, 25 insertions(+), 16 deletions(-) diff --git a/doc/createrepo_c.8.gz b/doc/createrepo_c.8.gz index d7c1ad19b6240747b10c29acce5cfec329b39430..6b39c6bcbb12dcf87ce86653462048ed1e5fc235 100644 GIT binary patch literal 1891 zcmV-p2b}mHiwFP{Mif&31D#mgZX3xFedkwHj66t*NL$`)5D3Boj?9&XwMl`bHVBr2 z(3)wI4bF6rx_d;?U%#iS=OWQ^00)+>nZBI5pQ`a_`G&qIOO;w{T5GGliaMv2cO`i} zkG{@g?RCD;PjNKBpT#G-n2kRy#4gU;A^G`JS@MS#6 zyat@tmAlJmIiw4DCtfIXI(jOLp|8qesiVqORL8OtOmu$FvaBZ`;`>tBp|QEPaaia_ zUC=w;%=Ibn&TzxWFUqft9W0lBJ*DN+{(&2%EZq*$6<&M|tKCnh&t5tA-J7?A;o#fN zcek%Bp1!vD{&p~G?6{hI98VU55rQ!~u!$GrEu7-!Mc;#;6(Z8R5 zN4N{|tWlG0Cas<{8_W5G@r@YlxFY{SXMQ)@!=#(lyB|e_0Y7q~7DFLw__rZtE;n|4 zMs-{b|HUhubI9xYe<#!H`PFja5kD!hZcJ|yjMZP7j)h{B-DR5t1IWhJ8{F~p$4 z6*sGbc#E)1h07GL38E?rT0!p)XDv8u@9K)z>2fx`x&HO)^H|WX8wL7(ycjE%;y1P2 z)S?AJ%QiaOhPtHl_USI}E1eX)*f{u@;zm<ffdlt-*+<>F1CWmnYR68CZ?PJqd-m_a>I%ma%+;!M z3oJwF<$JD*5IX=@$EuE;TkKb4DY^@rT-$7;?3zuMOeD?~j&(3!wVW+EbC2eR|xM9gUQ$LwM>c3r@7I&XDIg*+F6<7h;TKS_n%#$+3G2OE{KNzu%e;68XqFc4ayp93CwncuA= zVTA^;t8LyM>UzhBgnm=Gvgyw1mM5q}o)yNzi`F4;iab+34`L$Ib!(m#^BOf^)|5UCQWT9Rh;3Zdrfe|w&wqn-%CJ4L5d@eMb2Ub`!}sCQeN^kxiD%t@#ub^T7Oh!b<93> z6&%Sy5?U_uj!}C29M$3-eY~14X49m3T8U~c9Ol|&$trDloa`>KEwXsRg~@93%CkH` zdGcU-F`XO$=#Y7HuMaERM9f#K=MaxZ zX1Uq;_p3SPz?N}6g4j(^-KnG;s{M6!R4!~4IKkm~e2IO$yZ-HRe)kz}Oj({Pi?x!X zq$YQz#1+2gz{T7yRL-=ys*BWidSdRy?VR6Y5Ea--nnV%NW|eV6rFNDd1diKNfBETa z*IJ&widkJ#VZ!v>ot%9hv$VJz%B*zWzCRnR{?l-8cRP($kPl0Gq%D$kIfR+Z?#r@I z-hR&G6iXHxyK<@KgR6a(!by4Ux%Lj7VuXm`f0u0qcKie~Mh$oqw)^8IYtN`5EHvt_ ztBzU^ydBZeOqcHQpzZbtM7#8PArNI1_h}xmVldJNmqEXZ33x01buxYQ-z3ai3iC`r zCuvf?3qdo{KvVQ#(C})7E2xF2nI9GMn2B35gYTujY};nk={b_&qBNPu#EW{$!>BU( zTkc2&e(?dnkM zPx_&N#|z!EOh4pyq$cw+2G3e~Oi7yOThwR!{Q`!>=NeqkhO@tS-r05f1ib9PKyA6p dYK$F$&B`Gzgg) zC$aF@gY6+?e|^7W&jkWh+G;PEv5&uV`_A#1;cSb}g`r9;BrT+oP6S!d+}V?;_ zoRgKk&1sg=F{!fBvXmx>psXP~r(TBPjU(s7K`Bh8OaZw}%SWkck2eds&%0yDx^OPs zLYcvA_QO8SX67H9DC5%2ARXbwx3Jp%Bz^dX+`A`l2HD{C=HAU4i~Daa9^4FujUS_n zlhcdoV2Jn+H+-VX$-}{r#uH-i@boGw?^?JSiZ{+S5&dcZ9p%=C!^TXyzG&^F@oAJ# z7_Zb|$LiucgZXZ@vt*l*tM5gG1K)F?j*dcA_G3o5EtFXtQXS^m@4UjC1C=kYrlZS? z37(OV>?{7wvPbDW2s{}2YA{*a6>?@5PL#84@!+Z1B~zDo(vdI)$tT4H6d@iW#6zuQ zhydf-P<+$tR^+kOa%a8lgqrtW>?w-Lr(D;C^mJ5-{2rC;|A8quyA z1NwcuC=)%!FO@QgLIlyG`G}S;Wq$ALl8)M^+pw-=GVpk55n~EVNu3<;QVqWulY3QJ z44+CJGn?X&;?CQAuv1G@ycKdT5MolE45;Fl;^5ccT8pY^5lTLUb<}?@?vWfc-53kj z()VQ`KwT*UzicF8iz-y8&`yVRq=O zc#YLK&2jMxELitobp^2mGn#i{foJIY#hRqu1D+%N4gTLX=Cil~`u*28FnULtKGgEezK2h_VMvQN#4n z&zI33bdy|q&$`*O&3MkTvH)jbZ;b5qrb}#8bcwUvA4}JIw1Cg{sQzA6_#c;YYG`5`Fx@Wiz&>Dg``a;GDJ3dGt!>Rc z6zrc1<*siTcVom5o=qsotr#(_fD~UYdmz%GS zbm+9&sI@P~H+py4eCBL(^aY*PB^2NLRQwBLk<)gK!`!;k(=b)Jwu@P&RjH8Bbb&U? znJSncF{(uGv_QHps5?Zs*ZBh4P1%tGiAKroA}R>Yi>}<4lTiv4}m) zwq(gGsdzN(4zVwBahD5|&E}P7JV1H!ka>K0F~#tCJN5|d8#b7Di$R*+>IqJ@G*v7%-4k|xNXjBovxj}G56|L*4<+e zjj$JK5=BOvRmSy|SQ&nZaC|-Who8Q6SIg74=vH^BaKm(bJ6ZEQXK8Vk#aZd7eSbDs z{oVB5?sOWfpdX&}NcSM=EQ6b%ZA0&#y#1WV6iXf}Gq z_)rtn3P;`m!U$}2^xsKWK1KMk6=!_Aj{Z9QB)QaP)WL+sw8sfy;OyHNCuv9{%j}EI z{B+uWi%sD6s}ZSyuQ)WWP)g*zdu|9Iz7B_RsDcu(AYeMcYTqDed-cxkk`6 zraa$ux-Mwuf@aLHCDXXCMaUE3rY~|S_cG~ZvN3gIGOl2@i06y=VH`S8&oX7k)=Z#M zg>-;`z#Q(w?kHWMWK-+5770QcaKiv6hs#t}wZ0;mVHVbrV^fm=xya?I^Fep&X(KAs zI`Pe}M!26%=3x*;ukp8e;3ECK;^_){GgpQ+q*|JzMp4|A%-YlWItk*Z*+WZ!uGuY+ z&MKFR4syDto2+5W&C2ydvkF1jUzQYhI&jH0jF)U#;=2HPp7*o*MlA)CKL)0#L4+@O0Yk%B-k9aBn{QoiM`uc3W|nH6PoK?yajktXKT zb>Q|@)}?L)|K1?M%o0E6CE8;3yUy4?SWUa1v=ixCHG;BmcPnjzeV0WZD>B aYWf}^+&7@DB68VYcs~GHNpQs(2><}hsraw} literal 982 zcmV;{11bC;iwFRM2|H2%1D#e|Z{kK2e)q39jrx#uV>hHPUEZR^4M-s%FsfE{6b<&V zJ;k2!&Ws`a`#m$Zfhs#yL8M_ZXUp(JCRo=Xu5f07?Z(qEi%VYff5I#p!d0lGW@v|XMDSgei?iaTxv7yXu|Tj=Lz%B*|!)cVMrs(^pnN>u-ksi zP2l#kh?Kx*92%D>h4O#%A(1H;`4AeD`F~o8ojDrh=`0#gpBMC-8sf+P29>7S^#Wac zi$ZRxUouy$iZ9uB4V@N5Q>{<|6Di;uH=Va~2zJ`RuFt}O*!n}G%Fc#48>W(?B1QRjsc`W|*aQU_|hdRjz8vuT=r~Q*bfRk5a#Of^XjUNz z`(cN|b_XumhVhcEN_+>Phpu>VnYQh|x(1`KL2T63o)C545g3c4Y-m;OH2kNSJloGG z(NtI>^&Yr}lxG5#P zaD(njAqA0Mxk)KmLh)9+K8N=HF$G0)pv0QiNYmugigSArb)g%ObFMc0k z?V_yZzubX_!i|ajf4DL=Rj*(hE*sUm<<8BmlSPEb`E)t^Yy1>;J+Xr!;h?8KJyBxR zv+2=R4sBJ+WKHea!`wNxv@~>&b72d_z#Ud}pKDcDZsgn{g>Nl(*UoOvQ`gi0rlQ=z zR;qP3B(#MqF51Jy3HlQJPG9Xw{kVTZpVIiwFP{Mif&31D#b{Yuhjse)q39ggvxdZIbN52xZVV=^9ur#OX$K(f~Wxl!XYOMgavYxL}LP}6bvMWS{AV`Bqmc_ z>A*A3^bQ82ZvXaS(i@MSZU7qXX6uvR{Ak_=H0x3&c5W>b7M3j zOHM52(Qf-?Y#d)sWi$z#0w`Rf#+Coxhu91&Uv!|*ssGhV?97?T4j+c2ao7*NK;>^I z{88kZ3a(~wNqJsqsK)vmT#7nLJaeMsWlA$c z<(6RA2YF0Fqw%yq8k&5<(1D*(DnsRbgiG;a22d;{VbK}+qhO;2Ua&bzAUpwFQF}OS z;4HC0!=O8T823t&9Alc&7_3jH6e;K>*7do77n)@-M@Uf8=js5mCN^+R7y?a!3k|B| z!er~PESmE)DeG4oIe2xNl{s&5v0!FvDdmtin;+-YOj>PkqDqBCAc-9Zpc=GrM%EyJ zvjkI8Wcs|O-vn*@VJH}J&_ZE_QYCVU@o!Zy2=50wO<6lf zwSjBShN4cb18PaypTBHVEI9pBplx;JR}Ct2?ejP*%t=wTuAG^g-|WZNO}&66X1Oxm z*GoHPD~jq+Nfl*zcF^CZw)7;o!Rt|<3sn~LXSs%Qk5o44&VIVSn%>;q_J5Q`yskIb zmeaJ>eC)^$d%vuuy9%xK&@{cCXVb4bD0k+3uW#S^8WIr~nr6yeOWfVfFOq7M_6q(B LE8Q*9vj+eGHSBod literal 713 zcmV;)0yh00iwFRM2|H2%1D#dhZ`v>re$QWVLVM`8CIY5SD{n2(6=^^PbW^pU$|M(J zEw(e;f%4zac0%YNJTL`C=I*z+%HN_QFIKIO5&`5A67gSJ)1*s*z*FI z&B0b@PA6SCo8fUQ8f>eMe(anHE|l(7X~NTFpC`31c)Oi!W^ES+@N$H;&s& zJ(>b8F(_Q2CY1ldhsaDKU-zKUiT~9~?97=_o<1%{)5+YN4IzH$Z%`^Tyk4MkZ=Q;+ z;Y+L~Vc`||qoC3PFW3qt5FP`*QoB5rIg9l!M;H$l&yT~>NsbXsXaq4adtsGkFLa8) zP!lV=hAqu9SRuqH>1My67Lw2mIbjGi0WLJC(ig^ufD)P5po=tf#{h(txXh#fi*S-| z=-U?lleFc-xM0MY77F)Ps;Pg*{ zmg>;o6I9kZ;!#$Z#oAL>&P?s!jPF}guOY=OSB8C^+9`XbsG3@;+-J2ZUe#NAQP|+^ zsIP=7oB5+WgD7-f)bpG;+=}QZb+dGLyXZgMkG_{pyt8uW_u$h|YhHF_C&Ql>>8=Wk vo*2^Wc{Y62Nx2pMR^Lvm9mFCkG|iOxigR~&Z6(zx?G^PG-u*bL(*^(lSEO1& diff --git a/utils/gen_rst.py b/utils/gen_rst.py index cbbc836..7248ba4 100755 --- a/utils/gen_rst.py +++ b/utils/gen_rst.py @@ -7,8 +7,9 @@ from optparse import OptionParser class Info(object): - def __init__(self, name, description=None, synopsis=None, copyright=None, options=None): + def __init__(self, name, summary=None, description=None, synopsis=None, copyright=None, options=None): self.name = name + self.summary = summary self.description = description self.synopsis = synopsis self.copyright = copyright @@ -20,13 +21,12 @@ class Info(object): rst += "%s\n" % self.name rst += "%s\n\n" % ("=" * len(self.name),) - # Add synopsis - #if self.synopsis: - # rst += ":Synopsis: %s\n\n" % self.synopsis - - # Add description - if self.description: - rst += ":Subtitle: %s\n\n" % self.description + # Add summary + if self.summary: + rst += "%s\n" % ("-" * len(self.summary)) + rst += "%s\n" % self.summary + rst += "%s\n" % ("-" * len(self.summary)) + rst += "\n" # Add copyright if self.copyright: @@ -35,10 +35,17 @@ class Info(object): # Add date rst += ":Date: $Date: %s $\n\n" % datetime.datetime.strftime(datetime.datetime.utcnow(), format="%F %X") + # Add synopsis + if self.synopsis: + rst += "SYNOPSIS\n" + rst += "========\n\n" + for line in self.synopsis: + rst += "%s\n\n" % line + rst += "\n" + # Add options - rst += "-------\n" rst += "OPTIONS\n" - rst += "-------\n" + rst += "=======\n" for command in self.options: cmd = "" @@ -147,20 +154,22 @@ if __name__ == "__main__": if options.mergerepo: NAME = "mergerepo_c" info = Info(NAME, - description="C implementation of mergerepo", - synopsis="%s [options] " % (NAME,), + summary="Merge multiple repositories together", + synopsis=["%s --repo repo1 --repo repo2" % (NAME,)], options=args) elif options.modifyrepo: NAME = "modifyrepo_c" info = Info(NAME, - description="C implementation of modifyrepo", - synopsis="%s [options] " % (NAME,), + summary="Modify a repomd (xml-rpm-metadata) repository", + synopsis=["%s [options] " % (NAME,), + "%s --remove " % (NAME,), + "%s [options] --batchfile " % (NAME,) ], options=args) else: NAME = "createrepo_c" info = Info(NAME, - description="C implementation of createrepo", - synopsis="%s [options] " % (NAME,), + summary="Create repomd (xml-rpm-metadata) repository", + synopsis=["%s [options] " % (NAME,)], options=args) ret = info.gen_rst() -- 2.7.4