[opensuse-wiki] Style Guide: handling devices
Re: previous thread; I see that it is suggested that the style guide is discussed here. http://en.opensuse.org/OpenSUSE_Wiki_Guidelines Is there a policy on device identifiers, such as '/dev/sda', and how they should be represented in the wiki? If there isn't, with reference to this thread; http://forums.opensuse.org/looking-something-other-than-support/426354-urgen... Using 'sd's as an example, it seems to me that it might be sensible to have a policy of always rendering the first device mentioned as 'sdx', the second 'sdy', and the third 'sdz', unless N>3 devices are named, in which case picking the last N letters of the alphabet. This has the advantage of being consistent, of echoing common usage (we think of 'x' as being something we substitute - you could even emphasise that by making it italic) and therefore obvious to new users, and of being extremely unlikely to correspond to actual devices - particularly important as people will copy / paste commands like 'dd' or 'rm' into terminals, and possibly bring a carriage return with them, as discussed in the thread. Removing explicit carriage returns is also mentioned in the thread - I guess that can only help. -- To unsubscribe, e-mail: opensuse-wiki+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-wiki+help@opensuse.org
Mike Gentry wrote:
Re: previous thread; I see that it is suggested that the style guide is discussed here.
http://en.opensuse.org/OpenSUSE_Wiki_Guidelines
Is there a policy on device identifiers, such as '/dev/sda', and how they should be represented in the wiki?
If there isn't, with reference to this thread;
http://forums.opensuse.org/looking-something-other-than-support/426354-urgen...
Using 'sd's as an example, it seems to me that it might be sensible to have a policy of always rendering the first device mentioned as 'sdx', the second 'sdy', and the third 'sdz', unless N>3 devices are named, in which case picking the last N letters of the alphabet.
This has the advantage of being consistent, of echoing common usage (we think of 'x' as being something we substitute - you could even emphasise that by making it italic) and therefore obvious to new users, and of being extremely unlikely to correspond to actual devices - particularly important as people will copy / paste commands like 'dd' or 'rm' into terminals, and possibly bring a carriage return with them, as discussed in the thread.
Removing explicit carriage returns is also mentioned in the thread - I guess that can only help.
i agree and wonder if _maybe_ it shouldn't be sdX, sdY, sdX, etc dd -- To unsubscribe, e-mail: opensuse-wiki+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-wiki+help@opensuse.org
On Sunday 20 December 2009 00:37:28 DenverD wrote:
Removing explicit carriage returns is also mentioned in the thread - I guess that can only help.
i agree and wonder if maybe it shouldn't be
sdX, sdY, sdX, etc
The above is already very often used in discussions with people that have idea that /dev/sdX (etc) does not exist and must be substituted with something real like a, b, c etc. I just corrected the Linux section of the article http://en.opensuse.org/Live_USB_stick to use /dev/sdX . -- Regards Rajko, openSUSE Wiki Team: http://en.opensuse.org/Wiki_Team People of openSUSE: http://en.opensuse.org/People_of_openSUSE/About -- To unsubscribe, e-mail: opensuse-wiki+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-wiki+help@opensuse.org
Rajko M. wrote:
On Sunday 20 December 2009 00:37:28 DenverD wrote:
Removing explicit carriage returns is also mentioned in the thread - I guess that can only help. i agree and wonder if maybe it shouldn't be
sdX, sdY, sdX, etc
The above is already very often used in discussions with people that have idea that /dev/sdX (etc) does not exist and must be substituted with something real like a, b, c etc.
I just corrected the Linux section of the article http://en.opensuse.org/Live_USB_stick to use /dev/sdX .
Looks good to me - and less syntactically messy than italics. I guess the 's' term varies as well, but is often enough known when you're writing something, especially now the 'h's have more or less disappeared. -- To unsubscribe, e-mail: opensuse-wiki+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-wiki+help@opensuse.org
participants (3)
-
DenverD -
Mike Gentry -
Rajko M.