Difference between revisions of "User talk:Indigo"

From ArchWiki
Jump to: navigation, search
(Wireless Setup: rm'ing; talk done)
(wipe-safe-at: re, close)
 
(154 intermediate revisions by 18 users not shown)
Line 1: Line 1:
Feel free to leave comments about my wiki edits or other points of interest. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 17:43, 27 September 2012 (UTC)
+
Feel free to leave comments about my wiki edits or other points of interest. Please note I have changed preferences so that the account does not automatically watch articles I edit. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 23:31, 1 August 2015 (UTC)
  
====Comments====
+
== Comments ==
 +
 
 +
== <s>wipe-safe-at</s> ==
 +
 
 +
Hi! If you don't mind and have time then can you help with my second man page? I have cleaned up the code in the script with necessary comments and also wrote much about code in the man page, I don't know if it is a good idea but for them who want to edit and customize the script it might be useful.
 +
[https://github.com/AndyCrowd/safe-disk-wiper/blob/master/man-page.wipe,txt man-page]
 +
(Andy Crowd - [[wikipedia:蔡依林|蔡依林]] 17:33, 29 April 2016 (UTC)).
 +
 
 +
:Hi, sure, I'll reply here when I had time to look at it. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 08:12, 30 April 2016 (UTC)
 +
 
 +
:Hi, I had a look at your manpage for the tool. A number of the options don't make sense for me, i.e. I regard them as misleading. Examples of what I think is misleading:
 +
# --order mentions some command shortcuts (ddr, ddz, cprs,cpz) but these are explained nowhere.
 +
# With --show-me you require the user to use a "-e NO_DRY" .. well, have a look what [[w:Dry_run_(testing)]] usually means for a tool. Your usage of --no-dry-run (also "$NO_DRY" mentioned later in the example output) is - to my understanding - totally contrary to regular usage.
 +
# What does --safety=2/max (default) result in, if the tool "will stop if at least one partition is mounted"? Of course there is at least one partition mounted (/).
 +
 
 +
:I think your tool is more a hack for yourself to perform wipe actions you frequently perform. I don't see really how a user can benefit from the wiping part, because if a user understands the bash methods output in the first place, it is simpler to perform to create a dd command than to figure the method you define. Overall, I don't think you should package the tool as is (personal opinion, do as you wish of course). It does not make things simpler for a user.
 +
:The main benefit of the tool is to provide a wrapper around dd, so that no mounted partitions can be wiped by error. Ok, but that does not require such complicated scripting, you have already contributed [[Securely wipe disk/Tips and tricks#Prevent wiping mounted partitions]] for that, which users can [[Alias]] around dd, if they so prefer.
 +
 
 +
:I can improve the english of the manpage, but with misleading options that does not mean users get help. So, I'd rather not do that. Have a think about it how to proceed. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 20:19, 1 May 2016 (UTC)
 +
 
 +
:: I will remove many options from {{AUR|wipe-safe-at}} many options and will leave only '''dd''' command. I made another one that may be is much better for beginners, it doesn't wipe anything but only shows preconfigured commands that can be used to wipe a destination. To use for wiping is only need to copy/paste output or combine with commands xargs,cut,grep [[https://github.com/AndyCrowd/genwipe.sh/blob/master/genwipe.sh genwipe.sh]], take a look when you have time. I don't think that man page is necessary for genwipe.sh.(Andy Crowd - [[wikipedia:蔡依林|蔡依林]] 15:50, 14 July 2016 (UTC)).
 +
 
 +
::: Yes, good choice to drop the options. Three suggestions: (1) You should add a short sentence about what it does at the beginning of help (e.g. "This script helps to calculate parameters to '''wipe''' a device/partition with dd.") (2) At [https://github.com/AndyCrowd/genwipe.sh/blob/master/genwipe.sh#L47] you should say what "execute" means. (3) the commands at Line48 and 50 need to be swapped. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 20:56, 14 July 2016 (UTC)
 +
 
 +
:::: Is it OK if I will add something like "Thanks to: Indigo" into the "ShowHelp" in the [[https://github.com/AndyCrowd/genwipe.sh/blob/master/genwipe.sh genwipe.sh]]. It is finished now except grammar, all left to do is only to add more examples for different tools that need some of the device parameters. The "wipe-safe-at" will be removed from AUR. (Andy Crowd - [[wikipedia:蔡依林|蔡依林]] 17:11, 15 July 2016 (UTC)).
 +
 
 +
::::: Oh please, no thanks for such a minor suggestion. It's your choice of course, but you may want to save it for when you get me to work on its release 2 (I would take a bet that you won't stop changing and improving it with new ideas:). Grammar looks ok to me, perfectly understandable. I close this item then. Reopen it, if needed. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 17:44, 15 July 2016 (UTC)
 +
 
 +
== <s>Question about style regarding snippets</s> ==
 +
 
 +
Hi, I recently added the section about [[Etckeeper#Using_etckeeper_provided_hook|Using etckeeper provided hooks]] on the etckeeper page.
 +
I see that you are a wiki administrator. There is one thing about style and the wiki I don't really know, which is, whether we keep the
 +
comments in sample code ''as present in the original file'' or we edit them.
 +
 
 +
The small snippet of configuration included in the page was using the [https://github.com/joeyh/etckeeper/blob/master/etckeeper.conf#L45|exact verbiage used in the original configuration file].
 +
 
 +
The comments in the configuration snippet were put as they were in the configuration file to help finding the proper location and also give the context sensitive information they intend to give. What would be the proper etiquette about quoting partial configuration files? I don't think the [[Help:Style]] page touches that specific subject, except about the eliding of redundant lines.
 +
 
 +
I will not myself revert the change, as I think it would be rude to basically go after a Wiki Administrator's changes.
 +
 
 +
Thanks!
 +
 
 +
(Once resolved, this can be deleted from your talk page, if you wish)
 +
 
 +
[[User:Samueldr|Samueldr]] ([[User talk:Samueldr|talk]]) 14:40, 19 June 2016 (UTC)
 +
 
 +
:Hi, thanks for your comment. I did not check and was unaware you quoted the original configuration file. You are right, we should not change wording in such cases - that can be confusing to the reader indeed. But since the comments are there anyway and upstream may change wording of comments, whereas naming of options is less likely to change as quick, hopefully:), my suggestion would be to leave out the comments from the code out in total and just make an example of it.
 +
:I did this with [https://wiki.archlinux.org/index.php?title=Etckeeper&type=revision&diff=438544&oldid=438543] now.
 +
:Relevant style part is [[Help:Style#Code formatting]] (keeping in mind the note about comments in [[Help:Style#Command line text]]). I close this. If you are unhappy with the result, just reply here or expand the example instructions of that section again a little. --[[User:Indigo|Indigo]] ([[User talk:Indigo|talk]]) 16:59, 19 June 2016 (UTC)

Latest revision as of 17:44, 15 July 2016

Feel free to leave comments about my wiki edits or other points of interest. Please note I have changed preferences so that the account does not automatically watch articles I edit. --Indigo (talk) 23:31, 1 August 2015 (UTC)

Comments

wipe-safe-at

Hi! If you don't mind and have time then can you help with my second man page? I have cleaned up the code in the script with necessary comments and also wrote much about code in the man page, I don't know if it is a good idea but for them who want to edit and customize the script it might be useful. man-page (Andy Crowd - 蔡依林 17:33, 29 April 2016 (UTC)).

Hi, sure, I'll reply here when I had time to look at it. --Indigo (talk) 08:12, 30 April 2016 (UTC)
Hi, I had a look at your manpage for the tool. A number of the options don't make sense for me, i.e. I regard them as misleading. Examples of what I think is misleading:
  1. --order mentions some command shortcuts (ddr, ddz, cprs,cpz) but these are explained nowhere.
  2. With --show-me you require the user to use a "-e NO_DRY" .. well, have a look what w:Dry_run_(testing) usually means for a tool. Your usage of --no-dry-run (also "$NO_DRY" mentioned later in the example output) is - to my understanding - totally contrary to regular usage.
  3. What does --safety=2/max (default) result in, if the tool "will stop if at least one partition is mounted"? Of course there is at least one partition mounted (/).
I think your tool is more a hack for yourself to perform wipe actions you frequently perform. I don't see really how a user can benefit from the wiping part, because if a user understands the bash methods output in the first place, it is simpler to perform to create a dd command than to figure the method you define. Overall, I don't think you should package the tool as is (personal opinion, do as you wish of course). It does not make things simpler for a user.
The main benefit of the tool is to provide a wrapper around dd, so that no mounted partitions can be wiped by error. Ok, but that does not require such complicated scripting, you have already contributed Securely wipe disk/Tips and tricks#Prevent wiping mounted partitions for that, which users can Alias around dd, if they so prefer.
I can improve the english of the manpage, but with misleading options that does not mean users get help. So, I'd rather not do that. Have a think about it how to proceed. --Indigo (talk) 20:19, 1 May 2016 (UTC)
I will remove many options from wipe-safe-atAUR many options and will leave only dd command. I made another one that may be is much better for beginners, it doesn't wipe anything but only shows preconfigured commands that can be used to wipe a destination. To use for wiping is only need to copy/paste output or combine with commands xargs,cut,grep [genwipe.sh], take a look when you have time. I don't think that man page is necessary for genwipe.sh.(Andy Crowd - 蔡依林 15:50, 14 July 2016 (UTC)).
Yes, good choice to drop the options. Three suggestions: (1) You should add a short sentence about what it does at the beginning of help (e.g. "This script helps to calculate parameters to wipe a device/partition with dd.") (2) At [1] you should say what "execute" means. (3) the commands at Line48 and 50 need to be swapped. --Indigo (talk) 20:56, 14 July 2016 (UTC)
Is it OK if I will add something like "Thanks to: Indigo" into the "ShowHelp" in the [genwipe.sh]. It is finished now except grammar, all left to do is only to add more examples for different tools that need some of the device parameters. The "wipe-safe-at" will be removed from AUR. (Andy Crowd - 蔡依林 17:11, 15 July 2016 (UTC)).
Oh please, no thanks for such a minor suggestion. It's your choice of course, but you may want to save it for when you get me to work on its release 2 (I would take a bet that you won't stop changing and improving it with new ideas:). Grammar looks ok to me, perfectly understandable. I close this item then. Reopen it, if needed. --Indigo (talk) 17:44, 15 July 2016 (UTC)

Question about style regarding snippets

Hi, I recently added the section about Using etckeeper provided hooks on the etckeeper page. I see that you are a wiki administrator. There is one thing about style and the wiki I don't really know, which is, whether we keep the comments in sample code as present in the original file or we edit them.

The small snippet of configuration included in the page was using the verbiage used in the original configuration file.

The comments in the configuration snippet were put as they were in the configuration file to help finding the proper location and also give the context sensitive information they intend to give. What would be the proper etiquette about quoting partial configuration files? I don't think the Help:Style page touches that specific subject, except about the eliding of redundant lines.

I will not myself revert the change, as I think it would be rude to basically go after a Wiki Administrator's changes.

Thanks!

(Once resolved, this can be deleted from your talk page, if you wish)

Samueldr (talk) 14:40, 19 June 2016 (UTC)

Hi, thanks for your comment. I did not check and was unaware you quoted the original configuration file. You are right, we should not change wording in such cases - that can be confusing to the reader indeed. But since the comments are there anyway and upstream may change wording of comments, whereas naming of options is less likely to change as quick, hopefully:), my suggestion would be to leave out the comments from the code out in total and just make an example of it.
I did this with [2] now.
Relevant style part is Help:Style#Code formatting (keeping in mind the note about comments in Help:Style#Command line text). I close this. If you are unhappy with the result, just reply here or expand the example instructions of that section again a little. --Indigo (talk) 16:59, 19 June 2016 (UTC)