| 1 |
On Friday 25 May 2012 14:38:34 Steven J Long wrote: |
| 2 |
> > Steven J Long wrote: |
| 3 |
> >> You could maybe tighten the false-negative side by scanning all |
| 4 |
> >> functions defined in an eclass, and warning if they're undocumented. |
| 5 |
> > |
| 6 |
> > that happens now when you emerge eclass-manpages, but i suspect no one |
| 7 |
> > cares. if you run the script by hand on your eclass, it'll tell you the |
| 8 |
> > same thing. |
| 9 |
> |
| 10 |
> So, if eclass-manpages /is/ installed, then it gets used to check the |
| 11 |
> documentation by repoman? |
| 12 |
|
| 13 |
no. while generating the manpages, the script will warn you bad comment |
| 14 |
blocks or unknown keywords. |
| 15 |
|
| 16 |
$ cd /usr/portage |
| 17 |
$ ./app-portage/eclass-manpages/files/eclass-to-manpage.sh \ |
| 18 |
eclass/*.eclass |
| 19 |
... |
| 20 |
alternatives.eclass: |
| 21 |
warning:41: alternatives.eclass: no @MAINTAINER found |
| 22 |
... |
| 23 |
gnuconfig.eclass: |
| 24 |
error:103: eclass not documented yet (no @ECLASS found) |
| 25 |
... |
| 26 |
leechcraft.eclass: |
| 27 |
warning:12: Unexpected tag in "funcvar" state: # @DESCRIPTION: |
| 28 |
... |
| 29 |
-mike |
Archives