You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-dev@perl.apache.org by Per Einar Ellefsen <pe...@skynet.be> on 2002/06/15 16:25:51 UTC

Summarizing the prompt issue

Ok, we never reached a conclusion on this one :)

Let's see what the votes were, and decide like a democracy :) (I can 
understand why the ASF has a voting system):

'%' and 'root#'
Thomas, allan, Jonathan, Per Einar

'nu%' and 'su%'
Stas

'user%' and 'root#'
Bill

no prompt
Ask

It seems to me like '%' and 'root#' wins. I hope it won't cause too much 
controversy :)


-- 
Per Einar Ellefsen
per.einar@skynet.be



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Per Einar Ellefsen <pe...@skynet.be>.
At 17:32 15.06.2002, Stas Bekman wrote:
>Per Einar Ellefsen wrote:
>>Ok, we never reached a conclusion on this one :)
>>Let's see what the votes were, and decide like a democracy :) (I can 
>>understand why the ASF has a voting system):
>
>Yes, and most ASF projects exercise the voting system only among 
>committers (i.e. only committers votes count), also -1 from a committer 
>usualy means a veto, so no matter how
>many +1 there are, -1 is no go.

Well, that's all good for code... And if everyone can agree based on merits :)

>We probably will do the same because you cannot just take votes from 
>everyone who has happened to read the message and cared to reply without 
>defining what's the quorum, e.g. Randy, who is an active doc maintainer, 
>didn't vote.

Randy writes win32 docs, the discussion doesn't apply to him.

 > man%
>god#
>
>;)

hmm :)

>>no prompt
>>Ask
>>It seems to me like '%' and 'root#' wins. I hope it won't cause too much 
>>controversy :)
>
>I'm fine with any solution which uses some prompt, I think the 'root#' 
>prompt is wrong, because with 2.0 we are moving more into systems where 
>there is no such a thing as 'root'. And therefore I've suggested 'su' as 
>superuser (not su(1)), which is a generic concept. The second reason I've 
>mentioned is the alignment of the command.

But on those platforms the prompts won't be '%' or '#'!

>Hmm, still no go for some short name before the prompt? (mp == mod_perl?)
>
>mp% perl Makefile
>mp# make install

That one seems fine for me actually. New vote?


-- 
Per Einar Ellefsen
per.einar@skynet.be



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Stas Bekman <st...@stason.org>.
Thomas Klausner wrote:
> Hi!
> 
> A little late in the discussion, but:
> 
> I took a quick look at some books (mostly O'Reilly, and the mod_perl
> Cookbook), most of them seem to make no difference between normal and
> root prompts.
> 
> The Cookbook uses "$" and "#", but they use bold text for user input,
> so you should be able to discern a comment from a root-prompt. But I
> guess we can't do that (using bold text) ...
> 
> IMO '%' and '#' will work best, as '%' is used a lot already, and
> root-prompts are seldom.

Great minds think alike :) Even if sometimes their thoughts deviate :)

__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Thomas Klausner <do...@zsi.at>.
Hi!

A little late in the discussion, but:

I took a quick look at some books (mostly O'Reilly, and the mod_perl
Cookbook), most of them seem to make no difference between normal and
root prompts.

The Cookbook uses "$" and "#", but they use bold text for user input,
so you should be able to discern a comment from a root-prompt. But I
guess we can't do that (using bold text) ...

IMO '%' and '#' will work best, as '%' is used a lot already, and
root-prompts are seldom.


-- 
#!/usr/bin/perl                                http://domm.zsi.at
for(ref(bless[],just'another'perl'hacker)){s-:+-$"-g&&print$_.$/}

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Stas Bekman <st...@stason.org>.
>> yeah, I think % and # are fine when they used together in the same 
>> para, # is a bit confusing when used alone. I guess we should just use 
>> % and #, have a section of conventions and finish this issue. Those 
>> confused should have read the conventions, and if they didn't, it's 
>> their fault :)
> 
> 
> Ah, completely agreed! Finally we've come to understanding! I'll write 
> up the conventions and stick it somewhere, and voila, we're done with 
> the issue (and nothing changes... I hate change)!

;)

__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Per Einar Ellefsen <pe...@skynet.be>.
At 18:21 16.06.2002, Stas Bekman wrote:
>Bill Moseley wrote:
>>At 02:34 AM 06/16/02 +0800, Stas Bekman wrote:
>>
>>>1. people don't read convention pages.
>>
>>Yep I always skip those sections in books.
>
>;)
>
>I read some books right to left :)
>
>>>2. if you happen to have a single line
>>>
>>># make install
>>>
>>>some will think of it as a comment. And that's the only reason why I 
>>>suggest some prefix. Otherwise % and # are perfect with me.
>>
>>I guess no matter how hard you try someone will get confused.  Then if not
>>user% then % and root#.  That seems rather explicit.  I just think if you
>>are going to use letters that they should mean something to the person
>>reading it, and not be just place holders.
>>I suspect you, Stas, have probably the most experience regarding this with
>>questions you have received due to the guide.
>
>yeah, I think % and # are fine when they used together in the same para, # 
>is a bit confusing when used alone. I guess we should just use % and #, 
>have a section of conventions and finish this issue. Those confused should 
>have read the conventions, and if they didn't, it's their fault :)

Ah, completely agreed! Finally we've come to understanding! I'll write up 
the conventions and stick it somewhere, and voila, we're done with the 
issue (and nothing changes... I hate change)!


-- 
Per Einar Ellefsen
per.einar@skynet.be



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Stas Bekman <st...@stason.org>.
Bill Moseley wrote:
> At 02:34 AM 06/16/02 +0800, Stas Bekman wrote:
> 
>>1. people don't read convention pages.
> 
> 
> Yep I always skip those sections in books.

;)

I read some books right to left :)

>>2. if you happen to have a single line
>>
>> # make install
>>
>>some will think of it as a comment. And that's the only reason why I 
>>suggest some prefix. Otherwise % and # are perfect with me.
> 
> 
> I guess no matter how hard you try someone will get confused.  Then if not
> user% then % and root#.  That seems rather explicit.  I just think if you
> are going to use letters that they should mean something to the person
> reading it, and not be just place holders.
> 
> I suspect you, Stas, have probably the most experience regarding this with
> questions you have received due to the guide.

yeah, I think % and # are fine when they used together in the same para, 
# is a bit confusing when used alone. I guess we should just use % and 
#, have a section of conventions and finish this issue. Those confused 
should have read the conventions, and if they didn't, it's their fault :)

__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Bill Moseley <mo...@hank.org>.
At 02:34 AM 06/16/02 +0800, Stas Bekman wrote:
>1. people don't read convention pages.

Yep I always skip those sections in books.

>2. if you happen to have a single line
>
>  # make install
>
>some will think of it as a comment. And that's the only reason why I 
>suggest some prefix. Otherwise % and # are perfect with me.

I guess no matter how hard you try someone will get confused.  Then if not
user% then % and root#.  That seems rather explicit.  I just think if you
are going to use letters that they should mean something to the person
reading it, and not be just place holders.

I suspect you, Stas, have probably the most experience regarding this with
questions you have received due to the guide.


-- 
Bill Moseley
mailto:moseley@hank.org

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Stas Bekman <st...@stason.org>.
Bill Moseley wrote:
> At 11:32 PM 06/15/02 +0800, Stas Bekman wrote:
> 
> 
>>mp% perl Makefile
>>mp# make install
> 
> 
> If the letters don't mean anything special for the context they are shown
> in then I'd go for simply % and # and define those some place as % being a
> normal user prompt, and # is something that may require special privs.  I
> tend to get more confused about where a command needs to be run vs. by what
> user.  To we have a "conventions used on this site" page?

true, but:

1. people don't read convention pages.
2. if you happen to have a single line

  # make install

some will think of it as a comment. And that's the only reason why I 
suggest some prefix. Otherwise % and # are perfect with me.

> Personally, I also like seeing real-life examples instead of something
> generic.  Like a cut-n-paste of a real session -- I can then relate that to
> my OS (granted the examples is see are often linux).   But that takes too
> much room.

Yes, that's the main problem :(

__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Bill Moseley <mo...@hank.org>.
At 11:32 PM 06/15/02 +0800, Stas Bekman wrote:

>mp% perl Makefile
>mp# make install

If the letters don't mean anything special for the context they are shown
in then I'd go for simply % and # and define those some place as % being a
normal user prompt, and # is something that may require special privs.  I
tend to get more confused about where a command needs to be run vs. by what
user.  To we have a "conventions used on this site" page?

Personally, I also like seeing real-life examples instead of something
generic.  Like a cut-n-paste of a real session -- I can then relate that to
my OS (granted the examples is see are often linux).   But that takes too
much room.


-- 
Bill Moseley
mailto:moseley@hank.org

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Randy Kobes <ra...@theoryx5.uwinnipeg.ca>.
On Sat, 15 Jun 2002, Stas Bekman wrote:

> Per Einar Ellefsen wrote:
>
> > '%' and 'root#'
> > Thomas, allan, Jonathan, Per Einar
> >
> > 'nu%' and 'su%'
> > Stas
> >
> > 'user%' and 'root#'
> > Bill
>
> I suggest as a compromise to go with Bill's suggestion.
>
> Or if you want:
>
> man%
> god#
>
> ;)

but God doesn't make mistakes :)

>
> > no prompt
> > Ask
> >
> > It seems to me like '%' and 'root#' wins. I hope it won't cause too much
> > controversy :)
>
> I'm fine with any solution which uses some prompt, I think the 'root#'
> prompt is wrong, because with 2.0 we are moving more into systems where
> there is no such a thing as 'root'. And therefore I've suggested 'su' as
> superuser (not su(1)), which is a generic concept. The second reason
> I've mentioned is the alignment of the command.
>
> Hmm, still no go for some short name before the prompt? (mp == mod_perl?)
>
> mp% perl Makefile
> mp# make install

Assuming it's OK for Win32 (and perhaps others in OS-specific
docs) to have a platform-specific prompt, I like the latter -
it's aligned, and the directive for doing something special for
'make install' is clear (for those familiar with installing
stuff, which is safe to assume).

best regards,
randy


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Re: Summarizing the prompt issue

Posted by Stas Bekman <st...@stason.org>.
Per Einar Ellefsen wrote:
> Ok, we never reached a conclusion on this one :)
> 
> Let's see what the votes were, and decide like a democracy :) (I can 
> understand why the ASF has a voting system):

Yes, and most ASF projects exercise the voting system only among 
committers (i.e. only committers votes count), also -1 from a committer 
usualy means a veto, so no matter how many +1 there are, -1 is no go.

We probably will do the same because you cannot just take votes from 
everyone who has happened to read the message and cared to reply without 
defining what's the quorum, e.g. Randy, who is an active doc maintainer, 
didn't vote.

> '%' and 'root#'
> Thomas, allan, Jonathan, Per Einar
> 
> 'nu%' and 'su%'
> Stas
> 
> 'user%' and 'root#'
> Bill

I suggest as a compromise to go with Bill's suggestion.

Or if you want:

man%
god#

;)

> no prompt
> Ask
> 
> It seems to me like '%' and 'root#' wins. I hope it won't cause too much 
> controversy :)

I'm fine with any solution which uses some prompt, I think the 'root#' 
prompt is wrong, because with 2.0 we are moving more into systems where 
there is no such a thing as 'root'. And therefore I've suggested 'su' as 
superuser (not su(1)), which is a generic concept. The second reason 
I've mentioned is the alignment of the command.

Hmm, still no go for some short name before the prompt? (mp == mod_perl?)

mp% perl Makefile
mp# make install

__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org