[gentoo-dev] Gentoo beeping at me!

[gentoo-dev] Gentoo beeping at me!

[Roman Gaufman]

Hey,

Someone was bound to complain. I set xorg to emerge and go to sleep. I
fall asleep and it starts beeping! GRR! Doesnt it bother anyone? --
under no circumstances do I want  beeping.

I use portlog-info after emerge to read all einfo/ewarn/eerror
messages and who actually sits there watching the compile output for
hours? -- I do all compiling strictly when the machine is idle and
thats during the night.

So is ebeep really needed at all? -- if anything have an elog function
or something to stick a note in emerge.log or something if its that
crucial. I know this was discussed already, but please, no beeping.

Also, if you're going to use ebeep, how about an option in make.conf:
beep="no" # annoying beeping sound for those that actually watch the
compile output.

Regards
Roman Gaufman

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Mike Frysinger]

On Monday 22 November 2004 08:43 pm, Roman Gaufman wrote:
> Also, if you're going to use ebeep, how about an option in make.conf:
> beep="no" # annoying beeping sound for those that actually watch the
> compile output.

oh, you mean something like EBEEP_IGNORE ?
-mike

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Mike Frysinger]

On Monday 22 November 2004 11:19 pm, Lina Pezzella wrote:
> On Nov 22, 2004, at 8:51 PM, Mike Frysinger wrote:
> > oh, you mean something like EBEEP_IGNORE ?
>
> Please! I can't second this request enough. I like to have the pc
> speaker in my computer, but I've been sacrificing it to the benefit of
> actually sleeping while emerge -uD world runs.

what request ?  ebeep supports that variable already and has for quite a long 
time now
-mike

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Lina Pezzella]

On Nov 22, 2004, at 11:33 PM, Mike Frysinger wrote:

> On Monday 22 November 2004 11:19 pm, Lina Pezzella wrote:
>> On Nov 22, 2004, at 8:51 PM, Mike Frysinger wrote:
>>> oh, you mean something like EBEEP_IGNORE ?
>>
>> Please! I can't second this request enough. I like to have the pc
>> speaker in my computer, but I've been sacrificing it to the benefit of
>> actually sleeping while emerge -uD world runs.
>
> what request ?  ebeep supports that variable already and has for quite 
> a long
> time now
>
Interesting. I'm glad I caught this email thread so I could learn this. 
Could you kindly point me to the appropriate documentation on this?

Thanks!

>
> --
> gentoo-dev@gentoo.org mailing list
>


--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Mike Frysinger]

On Monday 22 November 2004 11:38 pm, Lina Pezzella wrote:
> Interesting. I'm glad I caught this email thread so I could learn this.
> Could you kindly point me to the appropriate documentation on this?

read the eclass like i did :p
-mike

--
gentoo-dev@gentoo.org mailing list

RE: [gentoo-dev] Gentoo beeping at me!

[Daniel Armyr]

>read the eclass like i did :p

And the user documentation?

--
Daniel Armyr
M. Sc. R&D Optics Design
Perimed AB
+48 8 580 119 90


--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 429 bytes --]

On Tue, 23 Nov 2004 08:38:50 +0100 "Daniel Armyr" <daniel.armyr@home.se>
wrote:
| >read the eclass like i did :p
| 
| And the user documentation?

There isn't any :) Read the original thread (started by me, subject was
"rfc: epause instead of sleep in ebuilds") for why.

-- 
Ciaran McCreesh : Gentoo Developer (Vim, Fluxbox, Sparc, Mips)
Mail            : ciaranm at gentoo.org
Web             : http://dev.gentoo.org/~ciaranm


[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Roman Gaufman]

On Tue, 23 Nov 2004 08:38:50 +0100, Daniel Armyr <daniel.armyr@home.se> wrote:
> >read the eclass like i did :p
> 
> And the user documentation?
> 
Where in the user documentation? -- I dont see it in make.conf.example
or in man emerge or in man portage.


> --
> Daniel Armyr
> M. Sc. R&D Optics Design
> Perimed AB
> +48 8 580 119 90
> 
> 
> 
> 
> --
> gentoo-dev@gentoo.org mailing list
> 
>

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Hasan Khalil]

On Nov 23, 2004, at 9:38, Roman Gaufman wrote:

> On Tue, 23 Nov 2004 08:38:50 +0100, Daniel Armyr 
> <daniel.armyr@home.se> wrote:
>>> read the eclass like i did :p
>>
>> And the user documentation?
>>
> Where in the user documentation? -- I dont see it in make.conf.example
> or in man emerge or in man portage.

AFAIK, there is no user documentation for most eclasses' options, 
including this one. That's the whole problem IMO.

But maybe that's just my opinion and it's not shared with anyone else, 
in which case this message should be disregarded.


--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 716 bytes --]

On Tue, 23 Nov 2004 10:55:14 -0500 Hasan Khalil <gongloo@gentoo.org>
wrote:
| AFAIK, there is no user documentation for most eclasses' options, 
| including this one. That's the whole problem IMO.

Well... Most eclasses don't provide anything that the user should be
concerned about... But, if someone wants to put this somewhere:

To disable the pause which is sometimes displayed after messages when
emerging a package, set EPAUSE_IGNORE="true" in /etc/make.conf. To
disable the beeps which are sometimes made after messages, also set
EBEEP_IGNORE="true".

-- 
Ciaran McCreesh : Gentoo Developer (Vim, Fluxbox, Sparc, Mips)
Mail            : ciaranm at gentoo.org
Web             : http://dev.gentoo.org/~ciaranm


[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Aaron Walker]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Ciaran McCreesh wrote:
| On Tue, 23 Nov 2004 10:55:14 -0500 Hasan Khalil <gongloo@gentoo.org>
| wrote:
| | AFAIK, there is no user documentation for most eclasses' options,
| | including this one. That's the whole problem IMO.
|
| Well... Most eclasses don't provide anything that the user should be
| concerned about... But, if someone wants to put this somewhere:
|
| To disable the pause which is sometimes displayed after messages when
| emerging a package, set EPAUSE_IGNORE="true" in /etc/make.conf. To
| disable the beeps which are sometimes made after messages, also set
| EBEEP_IGNORE="true".
|

IMO, it belongs in make.conf(5).

http://bugs.gentoo.org/show_bug.cgi?id=72325

- --
SEMPER UBI SUB UBI!!!!

[ Always wear underwater ]

Aaron Walker < ka0ttic@gentoo.org >	http://dev.gentoo.org/~ka0ttic/
Gentoo/BSD | cron | shell-tools		http://butsugenjitemple.org/~ka0ttic/

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.6 (GNU/Linux)

iD8DBQFBpF8gC3poscuANHARApuJAKC3sXViBkqrhLU7cLUGjvlDshFlbgCg5KMZ
tYUL6wCLmOp5aEcFxnw4BVY=
=3D2z
-----END PGP SIGNATURE-----

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Chris Gianelloni]

[-- Attachment #1: Type: text/plain, Size: 688 bytes --]

On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote:
> AFAIK, there is no user documentation for most eclasses' options, 
> including this one. That's the whole problem IMO.
> 
> But maybe that's just my opinion and it's not shared with anyone else, 
> in which case this message should be disregarded.

Like I say any time a dev mentions anything about a lack of
documentation...

There will be some as soon as you write it!

*grin*

I will admit that I am pretty bad about documentation myself, so it is
definitely something that we all need to work on improving.

-- 
Chris Gianelloni
Release Engineering - Operational/QA Manager
Games - Developer
Gentoo Linux

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Dan Meltzer]

Uhh... to stick my head in...

I'd be willing to write up some documentation for the various
eclasses, what format would you like them in? man-page style or what?


On Tue, 23 Nov 2004 11:20:35 -0500, Chris Gianelloni
<wolf31o2@gentoo.org> wrote:
> On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote:
> > AFAIK, there is no user documentation for most eclasses' options,
> > including this one. That's the whole problem IMO.
> >
> > But maybe that's just my opinion and it's not shared with anyone else,
> > in which case this message should be disregarded.
> 
> Like I say any time a dev mentions anything about a lack of
> documentation...
> 
> There will be some as soon as you write it!
> 
> *grin*
> 
> I will admit that I am pretty bad about documentation myself, so it is
> definitely something that we all need to work on improving.
> 
> --
> Chris Gianelloni
> Release Engineering - Operational/QA Manager
> Games - Developer
> Gentoo Linux
> 
> 
>

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Chris Gianelloni]

[-- Attachment #1: Type: text/plain, Size: 1386 bytes --]

On Tue, 2004-11-23 at 18:26 -0500, Dan Meltzer wrote:
> Uhh... to stick my head in...
> 
> I'd be willing to write up some documentation for the various
> eclasses, what format would you like them in? man-page style or what?

Man pages would be great for eclasses that do not already have them, or
need modifications to their existing man pages.

> On Tue, 23 Nov 2004 11:20:35 -0500, Chris Gianelloni
> <wolf31o2@gentoo.org> wrote:
> > On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote:
> > > AFAIK, there is no user documentation for most eclasses' options,
> > > including this one. That's the whole problem IMO.
> > >
> > > But maybe that's just my opinion and it's not shared with anyone else,
> > > in which case this message should be disregarded.
> > 
> > Like I say any time a dev mentions anything about a lack of
> > documentation...
> > 
> > There will be some as soon as you write it!
> > 
> > *grin*
> > 
> > I will admit that I am pretty bad about documentation myself, so it is
> > definitely something that we all need to work on improving.
> > 
> > --
> > Chris Gianelloni
> > Release Engineering - Operational/QA Manager
> > Games - Developer
> > Gentoo Linux
> > 
> > 
> >
> 
> --
> gentoo-dev@gentoo.org mailing list
> 
-- 
Chris Gianelloni
Release Engineering - Operations/QA Manager
Games - Developer
Gentoo Linux

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Aaron Walker]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Chris Gianelloni wrote:
| On Tue, 2004-11-23 at 18:26 -0500, Dan Meltzer wrote:
|
|>Uhh... to stick my head in...
|>
|>I'd be willing to write up some documentation for the various
|>eclasses, what format would you like them in? man-page style or what?
|
|
| Man pages would be great for eclasses that do not already have them, or
| need modifications to their existing man pages.

I've been working on this actually.

Dan, if you do decide you'd like to help out with eclass documentation, please
check bugzilla first.  I have at least half a dozen eclass manual pages that
I've written in the last couple days.

Cheers
- --
Go away, I'm all right.
		-- H.G. Wells' last words.

Aaron Walker < ka0ttic@gentoo.org >	http://dev.gentoo.org/~ka0ttic/
Gentoo/BSD | cron | shell-tools		http://butsugenjitemple.org/~ka0ttic/

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.6 (GNU/Linux)

iD8DBQFBpF2KC3poscuANHARAn/lAJwOz47dA75xZeA8o2HZwSfHMRPV6QCgrTDB
5O0JfEzVcCnw9TPCC6kb4a4=
=L74m
-----END PGP SIGNATURE-----

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Chris Gianelloni]

[-- Attachment #1: Type: text/plain, Size: 2135 bytes --]

On Tue, 2004-11-23 at 23:04 -0500, Dan Meltzer wrote:
> Aye Aye, I'm in the middle of building a gigantic rube goldberg, but
> Ill get to work on it over the next five days, I should have some time
> in there.

Nice.

Make sure to make the bug depend on bug #72339, which is a request to
have the eclass man pages moved into a separate package.

> On Tue, 23 Nov 2004 21:15:36 -0500, Chris Gianelloni
> <wolf31o2@gentoo.org> wrote:
> > On Tue, 2004-11-23 at 18:26 -0500, Dan Meltzer wrote:
> > > Uhh... to stick my head in...
> > >
> > > I'd be willing to write up some documentation for the various
> > > eclasses, what format would you like them in? man-page style or what?
> > 
> > Man pages would be great for eclasses that do not already have them, or
> > need modifications to their existing man pages.
> > 
> > 
> > 
> > > On Tue, 23 Nov 2004 11:20:35 -0500, Chris Gianelloni
> > > <wolf31o2@gentoo.org> wrote:
> > > > On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote:
> > > > > AFAIK, there is no user documentation for most eclasses' options,
> > > > > including this one. That's the whole problem IMO.
> > > > >
> > > > > But maybe that's just my opinion and it's not shared with anyone else,
> > > > > in which case this message should be disregarded.
> > > >
> > > > Like I say any time a dev mentions anything about a lack of
> > > > documentation...
> > > >
> > > > There will be some as soon as you write it!
> > > >
> > > > *grin*
> > > >
> > > > I will admit that I am pretty bad about documentation myself, so it is
> > > > definitely something that we all need to work on improving.
> > > >
> > > > --
> > > > Chris Gianelloni
> > > > Release Engineering - Operational/QA Manager
> > > > Games - Developer
> > > > Gentoo Linux
> > > >
> > > >
> > > >
> > >
> > > --
> > > gentoo-dev@gentoo.org mailing list
> > > 
> > --
> > Chris Gianelloni
> > Release Engineering - Operations/QA Manager
> > Games - Developer
> > Gentoo Linux
> > 
> > 
> >
> 
-- 
Chris Gianelloni
Release Engineering - Operational/QA Manager
Games - Developer
Gentoo Linux

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Benjamin Schindler]

I've got to throw an idea in here.... How about a doxygen-style
documentation? No, it doesn't have to be doxygen, but I'm thinking of
this idea. Instead of looking at every eclass, why not have some
standard-format documentation in an eclass itself and let a tool create
the documentation in whichever format he wishes to do so.
Just my 2 cents...
On Tue, 2004-11-23 at 18:26 -0500, Dan Meltzer wrote:
> Uhh... to stick my head in...
> 
> I'd be willing to write up some documentation for the various
> eclasses, what format would you like them in? man-page style or what?
> 
> 
> On Tue, 23 Nov 2004 11:20:35 -0500, Chris Gianelloni
> <wolf31o2@gentoo.org> wrote:
> > On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote:
> > > AFAIK, there is no user documentation for most eclasses' options,
> > > including this one. That's the whole problem IMO.
> > >
> > > But maybe that's just my opinion and it's not shared with anyone else,
> > > in which case this message should be disregarded.
> > 
> > Like I say any time a dev mentions anything about a lack of
> > documentation...
> > 
> > There will be some as soon as you write it!
> > 
> > *grin*
> > 
> > I will admit that I am pretty bad about documentation myself, so it is
> > definitely something that we all need to work on improving.
> > 
> > --
> > Chris Gianelloni
> > Release Engineering - Operational/QA Manager
> > Games - Developer
> > Gentoo Linux
> > 
> > 
> >
> 
> --
> gentoo-dev@gentoo.org mailing list
> 
> 
-- 
Benjamin Schindler <config@gentoo.org>
Gentoo Foundation


--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Georgi Georgiev]

maillog: 24/11/2004-21:10:14(+0100): Benjamin Schindler types
> I've got to throw an idea in here.... How about a doxygen-style
> documentation? No, it doesn't have to be doxygen, but I'm thinking of
> this idea. Instead of looking at every eclass, why not have some
> standard-format documentation in an eclass itself and let a tool create
> the documentation in whichever format he wishes to do so.
> Just my 2 cents...

Yep, was about to propose something based on perl's POD, but realized it
might be a little ugly to keep a large section of comment-ed out to-be
documentation in the eclass itself.

Or are you having something different in mind?

-- 
*>   Georgi Georgiev   *> You will be traveling and coming into a      *>
<*    chutz@gg3.net    <* fortune.                                     <*
*>  +81(90)6266-1163   *>                                              *>

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Ed Grimm]

On Thu, 25 Nov 2004, Georgi Georgiev wrote:

> maillog: 24/11/2004-21:10:14(+0100): Benjamin Schindler types
>> I've got to throw an idea in here.... How about a doxygen-style
>> documentation? No, it doesn't have to be doxygen, but I'm thinking of
>> this idea. Instead of looking at every eclass, why not have some
>> standard-format documentation in an eclass itself and let a tool create
>> the documentation in whichever format he wishes to do so.
>> Just my 2 cents...
>
> Yep, was about to propose something based on perl's POD, but realized it
> might be a little ugly to keep a large section of comment-ed out to-be
> documentation in the eclass itself.
>
> Or are you having something different in mind?

If you really think that in-line docs are ugly, use vim(1), and
automagically fold them out of your view (:help foldexpr, although this
can be set to happen in the eclass syntax file).  I suspect that most of
the people who only occasionally work with the eclasses, and those who
are just starting to use the eclasses, would find them more useful than
ugly.

Putting the documentation in-line makes it more convinient, so as to
lessen the excuse of, 'Well, I was going to update the docs after I knew
it worked, but I got distracted.'  Personally, I find it useful to
change the in-line documentation before I change the code; this way, if
I get distracted, any of the developers that share my development box
can see where I was going, including me six months later.  (This happens
far more often than I'd like.)  It can also help to focus ones ideas
before one starts coding.

Ed

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 582 bytes --]

On Thu, 25 Nov 2004 19:19:27 +0000 (GMT) Ed Grimm
<paranoid@gentoo.evolution.tgape.org> wrote:
| If you really think that in-line docs are ugly, use vim(1), and
| automagically fold them out of your view (:help foldexpr, although
| this can be set to happen in the eclass syntax file).

Hey, I could even make this happen automagically for you! It'd look
something like this:

http://dev.gentoo.org/~ciaranm/tmp/folding.png

-- 
Ciaran McCreesh : Gentoo Developer (Vim, Fluxbox, Sparc, Mips)
Mail            : ciaranm at gentoo.org
Web             : http://dev.gentoo.org/~ciaranm


[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Georgi Georgiev]

maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types
> On Thu, 25 Nov 2004, Georgi Georgiev wrote:
> 
> If you really think that in-line docs are ugly, use vim(1), and
> automagically fold them out of your view (:help foldexpr, although this
> can be set to happen in the eclass syntax file).  I suspect that most of
> the people who only occasionally work with the eclasses, and those who
> are just starting to use the eclasses, would find them more useful than
> ugly.

I have nothing against in-line docs in general. I simply had trouble
imagining it in the bash case.

What about using perldoc itself? Simply prepend every doc line with a
'#', then run

awk '/^#/ { sub("#",""); print }

on the file and pass this output to perldoc. This has the advantage of
having the necessary tools at hand already, so that no extra tools are
needed for the docs.

-- 
\    Georgi Georgiev   \  A lot of people I know believe in positive   \
 /    chutz@gg3.net     / thinking, and so do I. I believe              /
\   +81(90)6266-1163   \  everything positively stinks. ti -- Lew      \
 / -------------------  / Col                                           /

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 1193 bytes --]

On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev <chutz@gg3.net>
wrote:
| maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types
| > On Thu, 25 Nov 2004, Georgi Georgiev wrote:
| > 
| > If you really think that in-line docs are ugly, use vim(1), and
| > automagically fold them out of your view (:help foldexpr, although
| > this can be set to happen in the eclass syntax file).  I suspect
| > that most of the people who only occasionally work with the
| > eclasses, and those who are just starting to use the eclasses, would
| > find them more useful than ugly.
| 
| I have nothing against in-line docs in general. I simply had trouble
| imagining it in the bash case.
| 
| What about using perldoc itself? Simply prepend every doc line with a
| '#', then run
| 
| awk '/^#/ { sub("#",""); print }

In bash? How would that work?

Here's another possibility:

# {{{ doc
# whatever format we decide upon
# blah blah blah
# }}}

Doesn't screw up normal comments, really easy to find and process, easy
to turn into folds in the editor :)

-- 
Ciaran McCreesh : Gentoo Developer (Vim, Fluxbox, Sparc, Mips)
Mail            : ciaranm at gentoo.org
Web             : http://dev.gentoo.org/~ciaranm


[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Georgi Georgiev]

[-- Attachment #1: Type: text/plain, Size: 1747 bytes --]

maillog: 26/11/2004-10:17:34(+0000): Ciaran McCreesh types
> On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev <chutz@gg3.net>
> wrote:
> | maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types
> | > On Thu, 25 Nov 2004, Georgi Georgiev wrote:
> | > 
> | > If you really think that in-line docs are ugly, use vim(1), and
> | > automagically fold them out of your view (:help foldexpr, although
> | > this can be set to happen in the eclass syntax file).  I suspect
> | > that most of the people who only occasionally work with the
> | > eclasses, and those who are just starting to use the eclasses, would
> | > find them more useful than ugly.
> | 
> | I have nothing against in-line docs in general. I simply had trouble
> | imagining it in the bash case.
> | 
> | What about using perldoc itself? Simply prepend every doc line with a
> | '#', then run
> | 
> | awk '/^#/ { sub("#",""); print }
> 
> In bash? How would that work?

I imagined

#=item blah blah
# more POD
# and more
# and more
#=cut

> Here's another possibility:
> 
> # {{{ doc
> # whatever format we decide upon
> # blah blah blah
> # }}}
> 
> Doesn't screw up normal comments, really easy to find and process, easy
> to turn into folds in the editor :)

Sounds great. Now all that's left is to agree upon the format and write
the converter. Oh, and my favorite -- a GLEP maybe? (no, I'm not
sarcastic; just in a good mood ;) ).

-- 
 )   Georgi Georgiev    ) Hi! I'm Larry. This is my brother Bob, and    )
(     chutz@gg3.net    (  this is my other brother Jimbo. We thought   (
 )  +81(90)6266-1163    ) you might like to know the names of your      )
(  ------------------- (  assailants.                                  (

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Dan Meltzer]

Id prefer to see something like 
#///
#/
#/
#/
#///

that is, each line that goes into documenetation has a prepending
character, so that It is easy to tell it apart without folding,

then again, maybe it doesnt need to be told apart...

or a more in depth one, something like
#///<documentation>
#///<feature>
#///<name>feature name</name>
#///<description>a short description of the problem</description>
#///<paramater>a paramater that could be passed to it</parameter>
#///</feature>
#///<feature>
same as before...
#///</docuementation>

that way all documentation can just be extracted as xml... making
parsing to a web page, or a man page, or whatever, a lot easier IMO

(yes, this was stolen shamelessly from .net's documentation standards :))


On Sat, 27 Nov 2004 03:03:52 +0900, Georgi Georgiev <chutz@gg3.net> wrote:
> maillog: 26/11/2004-10:17:34(+0000): Ciaran McCreesh types
> 
> 
> > On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev <chutz@gg3.net>
> > wrote:
> > | maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types
> > | > On Thu, 25 Nov 2004, Georgi Georgiev wrote:
> > | >
> > | > If you really think that in-line docs are ugly, use vim(1), and
> > | > automagically fold them out of your view (:help foldexpr, although
> > | > this can be set to happen in the eclass syntax file).  I suspect
> > | > that most of the people who only occasionally work with the
> > | > eclasses, and those who are just starting to use the eclasses, would
> > | > find them more useful than ugly.
> > |
> > | I have nothing against in-line docs in general. I simply had trouble
> > | imagining it in the bash case.
> > |
> > | What about using perldoc itself? Simply prepend every doc line with a
> > | '#', then run
> > |
> > | awk '/^#/ { sub("#",""); print }
> >
> > In bash? How would that work?
> 
> I imagined
> 
> #=item blah blah
> # more POD
> # and more
> # and more
> #=cut
> 
> > Here's another possibility:
> >
> > # {{{ doc
> > # whatever format we decide upon
> > # blah blah blah
> > # }}}
> >
> > Doesn't screw up normal comments, really easy to find and process, easy
> > to turn into folds in the editor :)
> 
> Sounds great. Now all that's left is to agree upon the format and write
> the converter. Oh, and my favorite -- a GLEP maybe? (no, I'm not
> sarcastic; just in a good mood ;) ).
> 
> --
>  )   Georgi Georgiev    ) Hi! I'm Larry. This is my brother Bob, and    )
> (     chutz@gg3.net    (  this is my other brother Jimbo. We thought   (
>  )  +81(90)6266-1163    ) you might like to know the names of your      )
> (  ------------------- (  assailants.                                  (
> 
> 
>

--
gentoo-dev@gentoo.org mailing list

Re: [gentoo-dev] Gentoo beeping at me!

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 495 bytes --]

On Fri, 26 Nov 2004 13:45:22 -0500 Dan Meltzer
<parallelgrapefruit@gmail.com> wrote:
| Id prefer to see something like 
| #///
| #/
| #/
| #/
| #///
| 
| that is, each line that goes into documenetation has a prepending
| character, so that It is easy to tell it apart without folding,

Ick. Excessive amounts of garbage on each line...

-- 
Ciaran McCreesh : Gentoo Developer (Vim, Fluxbox, Sparc, Mips)
Mail            : ciaranm at gentoo.org
Web             : http://dev.gentoo.org/~ciaranm


[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [gentoo-dev] Gentoo beeping at me!

[Ed Grimm]

On Sat, 27 Nov 2004, Georgi Georgiev wrote:

> maillog: 26/11/2004-10:17:34(+0000): Ciaran McCreesh types
>> On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev <chutz@gg3.net>
>> wrote:
>>| I have nothing against in-line docs in general. I simply had trouble
>>| imagining it in the bash case.
>>|
>>| What about using perldoc itself? Simply prepend every doc line with a
>>| '#', then run
>>|
>>| awk '/^#/ { sub("#",""); print }
>>
>> In bash? How would that work?
>
> I imagined
>
> #=item blah blah
> # more POD
> # and more
> # and more
> #=cut

Note that Pod::Parser has a method (preprocess_line) which one could
utilize to do the strip without requiring an awk pre-processing step.

That being said, as the pod reformatting packages are written as
Pod::Parser subclasses, I'm not certain if it could be utilized
gracefully without limiting the potential output formats.  It may be
possible to make a generic class which does the magic, and a magical
subclass of that class which inherits from both it and a particular
formatting subclass, such that preprocess_line comes from the generic
class, and everything else comes from the formatting subclass.

Ed

--
gentoo-dev@gentoo.org mailing list