<!DOCTYPE html>
<html>
<head>
<title></title>
</head>
<body><div>Hi Nic,<br></div>
<div> </div>
<div>So it turns out that the regex I inherited from the other code wasn't escaping the hyphen properly, so that particular instance didn't like cyrus-master(8).<br></div>
<div> </div>
<div>And then in the interests of completeness, I tried doing the manpage/cyrusman substitution for myself, and we appear to have some references to :manpage:`cyradmin(1p)` in cyr_expire. So I've catered for that too now.<br></div>
<div> </div>
<div>New stuff all shiny and committed.<br></div>
<div> </div>
<div>Our use of section 8 vs section 1 seems a bit inconsistent. For the moment the cyrusman role just looks for all section 8 and section 1 stuff in the same "commands" directory. Should they actually be split apart into separate directories? What does the generated man page layout look like? Ideally our html should match.<br></div>
<div> </div>
<div>Time to feed the kids fish and chips before I go frolicking off for some tasty tapas.</div>
<div> </div>
<div> Nicola</div>
<div> </div>
<div> </div>
<div>On Fri, Aug 14, 2015, at 01:19 PM, Nic Bernstein wrote:<br></div>
<blockquote type="cite"><div>Nicola,<br></div>
<div>
Well, still not working for me. Is it working for you?<br></div>
<div> </div>
<div>
Here's what I get after performing a "git pull":<br></div>
<div> </div>
<blockquote><pre><a href="mailto:nic@flatboy:~/Checkouts/cyrus.foundation/cyrus-docs$">nic@flatboy:~/Checkouts/cyrus.foundation/cyrus-docs$</a> for file in `grep -lR ":manpage:" source/imap`; do sed -i $file -e 's/:manpage:/:cyrusman:/g'; done
<a href="mailto:nic@flatboy:~/Checkouts/cyrus.foundation/cyrus-docs$">nic@flatboy:~/Checkouts/cyrus.foundation/cyrus-docs$</a>make man html
sphinx-build -b cyrman -d build/doctrees source build/man
Running Sphinx v1.2.2
Initializing cyrusman plugin
loading pickled environment... not yet created
building [cyrman]: all manpages
updating environment: 274 added, 0 changed, 0 removed
reading sources... [ 6%] imap/admin/commands/ctl_conversationsdb
:cyrusman: error:
imap/admin/commands/ctl_conversationsdb: 159: Missing man page section for 'cyrus-master(8)'.
make: *** [man] Error 1
<br></pre></blockquote><div>It struck me as odd that the error message, about no man page
section, itself included a man page section. Upon checking, I see
this:<br></div>
<div> </div>
<blockquote><pre>See Also
========
:cyrusman:`imapd.conf(5)`, :cyrusman:`cyrus-master(8)`
<br></pre></blockquote><div>So I think whatever check your cyrusman 'role' is performing has a
problem.<br></div>
<div> </div>
<div>
It's too late in the evening, being 3-scotch o'clock, for me to
diagnose this from this side of the world. ;-0<br></div>
<div>
-nic<br></div>
<div> </div>
<div> </div>
<div>On 08/13/2015 09:25 PM, Nicola Nye
wrote:<br></div>
<blockquote type="cite" cite="mid:1439519126.2727914.355874537.07C73543@webmail.messagingengine.com"><div>Hi Nic,<br></div>
<div> <br></div>
<div>There were a bunch of :manpage: references that were missing
the (x) section number. I've amended the pages and committed a
new version of the code which provides better reporting.<br></div>
<div> <br></div>
<div>Do you know if there's any :manpage: references that are
referencing non-cyrus content? (We don't want to :cyrusman:ls
for instance)<br></div>
<div> <br></div>
<div> Let me know if this works any better for you!<br></div>
<div> <br></div>
<div>On Fri, Aug 14, 2015, at 01:00 AM, Nic Bernstein wrote:<br></div>
<blockquote type="cite"><div>On 08/13/2015 12:15 AM, Nicola Nye wrote:<br></div>
<div> <br></div>
<blockquote cite="mid:1439442908.2065313.355003409.083DA734@webmail.messagingengine.com" type="cite"><div>Delicious victory is mine!<br></div>
<div> <br></div>
<div>We now have a :cyrusman: sphinx option which generates
urls into our docs.cyrus.foundation tree, performing string
munging magic to match the generated url to our directory
and filename structure.<br></div>
<div> <br></div>
<div>Now, to look at updating all the references in our
existing docs so that it uses the new tag...<br></div>
<div> <br></div>
</blockquote><div> <br></div>
<div>Nicola,<br></div>
<div>Doesn't work for me.<br></div>
<div> <br></div>
<div>I pulled your changes, and then ran the following script to
replace all :manpage: references with :cyrusman:<br></div>
<div> <br></div>
<blockquote><pre>$ for file in `grep -lR ":manpage:" source/imap`; do sed -i $file -e 's/:manpage:/:cyrusman:/g'; done
<br></pre></blockquote><div>Then I ran a build:<br></div>
<div> <br></div>
<blockquote><pre>$ make man html
sphinx-build -b cyrman -d build/doctrees source build/man
Running Sphinx v1.2.2
Initializing cyrusman plugin
loading pickled environment... done
building [cyrman]: all manpages
updating environment: [extensions changed] 274 added, 18 changed, 0 removed
reading sources... [ 3%] imap/admin/access-control/rights-reference
<span class="colour" style="color:rgb(204, 0, 0)">Exception occurred</span>:
File "/home/nic/Checkouts/cyrus.foundation/cyrus-docs/source/exts/sphinxlocal/writers/cyrusman.py", line 49, in man_role
manpage_num = m.group(2)
AttributeError: 'NoneType' object has no attribute 'group'
<span class="colour" style="color:rgb(204, 0, 0)">The full traceback has been saved in /tmp/sphinx-err-yWaXf3.log, if you want to report the issue to the developers.</span><br></pre></blockquote><div>Full traceback is attached.<br></div>
<div> <br></div>
<div>Cheers,<br></div>
<div>-nic<br></div>
<div> <br></div>
<pre>--
Nic Bernstein <a href="mailto:nic@onlight.com">nic@onlight.com</a>
Onlight llc. <a href="http://www.onlight.com">www.onlight.com</a>219 N. Milwaukee St., Ste. 2A v. 414.272.4477
Milwaukee, Wisconsin 53202 f. 414.290.0335
<br></pre><p>Email had 1 attachment:<br></p><ul><li><div><code>sphinx-err-yWaXf3.log</code><br></div>
<div> 8k (text/x-log)<br></div>
</li></ul></blockquote><div> <br></div>
</blockquote><div> </div>
<pre>--
Nic Bernstein <a href="mailto:nic@onlight.com">nic@onlight.com</a>
Onlight Inc. <a href="http://www.onlight.com">www.onlight.com</a>6525 W Bluemound Rd., Ste 24 v. 414.272.4477
Milwaukee, Wisconsin 53213-4073 f. 414.290.0335
<br></pre></blockquote><div> </div>
</body>
</html>