Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 100253 - remove me from docs authorship
Summary: remove me from docs authorship
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Sven Vermeulen (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-07-25 10:51 UTC by Aron Griffis (RETIRED)
Modified: 2005-07-28 08:02 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Aron Griffis (RETIRED) gentoo-dev 2005-07-25 10:51:11 UTC
I can't see any reason that I'm mentioned in almost every piece of documentation
on the site.  I'd rather not be mentioned in any of them, regardless of what I
contribute.

Here is an easy way to remove me:

cd xml/htdocs
find . -name \*.xml | xargs perl -i -0777 -pe \
's/\n<author.*\s*<mail link="agriffis\@.*\n<.author.*//g'
cvs diff
cvs commit -m "remove agriffis per his request"

If I need to be listed somewhere as a partial copyright holder for the sake of
the documentation licensing, it would be nice if that were available on a
separate page.  IMHO the only people that should be listed per-document are the
1-2 *primary* contributers, otherwise it's just a huge meaningless list.
Comment 1 Sven Vermeulen (RETIRED) gentoo-dev 2005-07-25 10:58:32 UTC
We keep this information in the guides themselves, not elsewhere, since they are
really guide-specific. You don't want your name listed or is it your e-mail that
you want removed? 

We can easily do 

<author title="Whatever">
  Aron Griffis
</author>

instead of

<author title="Whatever">
  <mail link="agriffis@gentoo.org">Aron Griffis</mail>
</author>

which happens quite a lot. Otherwise I would prefer to comment you out, like

<!-- Does not want to be listed on the rendered page
<author title="Whatever">
  <mail link="agriffis@gentoo.org">Aron Griffis</mail>
</author>
-->
Comment 2 Xavier Neys (RETIRED) gentoo-dev 2005-07-25 11:32:39 UTC
(In reply to comment #0)
> I can't see any reason that I'm mentioned in almost every piece of
documentation on the site.

You're not. You're only listed in the handbook and the following docs:
neysx@basil ~/gentoo.org/gentoo/xml/htdocs/doc $ grep -Rl agriffis *|grep -v
handbook
en/articles/lpi-101-fundamentals-p1.xml
en/articles/lpi-101-administration-p2.xml

and in the following files
/proj/en/base/index.xml
/proj/en/metastructure/userinfo.xml
/proj/en/metastructure/herds/pkgList.xml
/proj/en/metastructure/herds/herds.xml
/proj/en/devrel/manager-meetings/logs/2003/20031201.txt
/proj/en/devrel/manager-meetings/logs/2004/20040719.txt
/proj/en/devrel/roll-call/userinfo.xml
/proj/en/releng/release/2004.3/2004.3.xml
/proj/en/releng/release/2005.0/2005.0.xml
/proj/en/releng/release/2005.1/2005.1.xml
/proj/en/keychain/index.xml
which are not under our control.

That's hardly most of 5000+ xml files.
You also appear in a few GWNs, many of which would be a pita to fix because they
are not valid anymore and can't be committed as such.
Comment 3 Aron Griffis (RETIRED) gentoo-dev 2005-07-25 12:12:58 UTC
Sven and Xavier, thanks for the quick replies on this silly bug.

First, Xavier, I'm sorry, I exaggerated the number of hits.  I've just been
surprised to find my name on so many handbook pages.  It seems like overkill. 
Personally I find the print pages a lot easier to read without the huge list of
people on the RHS of the page.  Maybe it's just me... ;-)

Sven, I like the option of being excluded from the rendered pages.  I also like
the option of not including my email address.  So here's an updated command:

cd xml/htdocs/doc
find . -name \*.xml | xargs perl -i -0777 -pe \
's|\n<author.*\s*<mail link="agriffis\@.*\n<.author.*|
<!-- Does not want to be listed on the rendered page
<author title="Gentoo Developer">
  Aron Griffis
</author>
-->|g'

Of course I still recommend the cvs diff prior to commit... ;-)
Comment 4 Sven Vermeulen (RETIRED) gentoo-dev 2005-07-28 08:02:22 UTC
Finished; thanks for the one-liner.