Merge lp:~clissold345/ubuntu-docs/fix-for-1651360 into lp:~ubuntu-core-doc/ubuntu-docs/trunk2017-07-10

Proposed by Chris Perry
Status: Merged
Merged at revision: 585
Proposed branch: lp:~clissold345/ubuntu-docs/fix-for-1651360
Merge into: lp:~ubuntu-core-doc/ubuntu-docs/trunk2017-07-10
Diff against target: 134 lines (+65/-46)
1 file modified
ubuntu-help/C/disk-format.page (+65/-46)
To merge this branch: bzr merge lp:~clissold345/ubuntu-docs/fix-for-1651360
Reviewer Review Type Date Requested Status
Gunnar Hjalmarsson Approve
Review via email: mp+313922@code.launchpad.net

Description of the change

I've made "wipe" a bit more prominent in the text since "wipe" is the term used in the page title.

Terminology: "USB flash drive".

I've assumed that the options that Disks offers in formatting the disk and creating a partition are sensible so I haven't described them. I've written the text for users who aren't much interested in the technical details, they just want something that works (most of the time).

The only decision that the user needs to make is whether to securely wipe the disk (or not). The message in the GUI is a bit confusing since it implies that a secure wipe isn't always secure (presumably it is secure if the format completes without error messages?).

I've deleted the mention of the shred command since if Disks can do a secure wipe the user doesn't need to use shred.

Do you mind running through the procedures for me (if you can)? Disks (16.04) was regularly closing and giving error messages while I was trying to check the procedures. The USB flash drive that I'm using seems to be fine since partition operations on it in Gparted work fine.

I deliberately started from the beginning in procedure 2, just in case the user closed Disks after wiping the disk. Of course I could have instead assumed that the user was still in Disks with the disk selected.

To post a comment you must log in.
Revision history for this message
Doug Smythies (dsmythies) wrote :

A few years ago Ubuntu desktop help was very very tightly linked with gnome help, and the majority of the files were the same. Subtle required differences were dealt with via the "if:choose" - "if:when test platform" stuff.

The last time we re-synced with the gnome help source was a few years ago, and Kevin Goodby was the driving lead. Prior to that, Jeremy used to push stuff up to gnome help to help keep the files in sync (or so I think it was).

With the deletion of the "if" conditions, we need to be aware that we are deviating from the past process, and it will difficult to go back. I think it is O.K. to go this way (mainly because I don't even use gnome and was never a contributor to gnome help), I just want us all to be aware (and I think I mentioned this somewhere before).

References:
https://help.ubuntu.com/stable/ubuntu-help/disk-format.html
https://help.gnome.org/users/gnome-help/stable/disk-format.html.en

Revision history for this message
Chris Perry (clissold345) wrote :

Hi Doug, sorry about the confusion. Yes I removed the "if" conditions from this page. I didn't mention it in my comment because I OKed it with Gunnar by email before I did it. I think it would have been better if I'd sent the email to you as well as Gunnar. In future (where I think it's relevant) I think I'll send emails to both of you. Is that OK with you? Regards, Chris.

Revision history for this message
Doug Smythies (dsmythies) wrote :

Hi Chris,

O.K. thanks for the information. Yes, I'd like to get any e-mails about this stuff, although Gunnar and I do tend to think very much alike. Also, I know we had some discussion about this before, but I haven't been able to find the old e-mails or whatever.

Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

Hi Doug,

Yeah, I'm very well aware of that implication. This is what I wrote to Chris:

> Yeah, go ahead and drop it. We have diverged from GNOME to such an
> extent that we won't be able to 'merge' their updates without careful
> proofreading anyway.

Right or wrong, but that's how I see it.

Ideally we would have had enough resources to keep in sync with GNOME as well as possible, but that's not the case. If/when we find the time to do it, then it will have to be quite a large project where we manually compare each and one of the pages we share with GNOME Help.

Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

This looks fine to me. I already tested it successfully when we started to talk via email.

I'd suggest that you merge this one, so we can focus on the other MP (where I have a few thoughts).

review: Approve
Revision history for this message
Chris Perry (clissold345) wrote :

Thanks for your reply. So I want to push my local copy of the help up to and including revision 585? What's the command to do that?

Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

Ouch.. I don't know.

Let's wait then, and finalize the discussion about the other page, and then you can push both.

Revision history for this message
Doug Smythies (dsmythies) wrote :

I could do the merge, since I have not pulled the stuff yet. I would only have to merge this one, and then push it. However, since the other one includes both, I think it might mess things up.

Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

That's true, Doug. But yes, the revision history gets cleaner if we wait, and since this is two separate pages I think it makes most sense to wait.

Revision history for this message
Chris Perry (clissold345) wrote :

I had a look at:

http://doc.bazaar.canonical.com/bzr.dev/en/tutorials/tutorial.html

I'd say that the command is likely to be:

bzr push -r ..585 lp:ubuntu-docs

(push everything up to and including revision 585).

Is it safe for me to try it?

Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

Sure, go ahead. Nothing will explode if you do, and we may learn something. :)

Revision history for this message
Chris Perry (clissold345) wrote :

bzr didn't like my first guess (see earlier comment) but this command worked:

bzr push -r 585 lp:ubuntu-docs

So trunk is now up to revision 585.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'ubuntu-help/C/disk-format.page'
2--- ubuntu-help/C/disk-format.page 2014-02-03 22:25:25 +0000
3+++ ubuntu-help/C/disk-format.page 2016-12-30 10:06:03 +0000
4@@ -14,65 +14,84 @@
5 <revision pkgversion="3.4.0" date="2012-02-19" status="review"/>
6 <revision version="13.10" date="2013-09-07" status="review"/>
7
8- <desc>Remove all of the files and folders from an external hard disk or USB
9+ <desc>Delete all of the files and folders from an external hard disk or USB
10 flash drive by formatting it.</desc>
11+
12 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
13 </info>
14
15-<title>Wipe everything off a removable disk</title>
16+<title>Wipe the data off a removable disk and reuse it</title>
17
18- <p>If you have a removable disk, like a USB memory stick or an external hard
19- disk, you may sometimes wish to completely remove all of its files and
20+ <p>If you have a removable disk, like a USB flash drive or an external hard
21+ disk, you may sometimes wish to wipe the disk, that is, completely delete all its files and
22 folders. You can do this by <em>formatting</em> the disk - this deletes all
23- of the files on the disk and leaves it empty.</p>
24-
25+ the files on the disk and leaves it empty.</p>
26+
27+
28+<p>To format a removable disk:</p>
29 <steps>
30- <title>Format a removable disk</title>
31+
32 <item>
33-<if:choose>
34-<if:when test="platform:unity">
35 <p>Open the <app>Disks</app> application from the <gui>Dash</gui>.</p>
36-</if:when>
37- <p>Open the <app>Disks</app> application from the <gui>Activities</gui>
38- overview.</p>
39-</if:choose>
40 </item>
41+
42 <item>
43- <p>Select the disk you want to wipe from the <gui>Storage Devices</gui> list.</p>
44+ <p>Select the disk that you want to wipe from the list on the left.</p>
45
46 <note style="warning">
47- <p>Make sure that you have selected the correct disk! If you choose the wrong
48- disk, all of the files on the other disk will be deleted!</p>
49+ <p>Make sure that you have selected the correct disk! If you select the wrong
50+ disk, all the files on the other disk will be deleted!</p>
51 </note>
52- </item>
53- <item>
54- <p>In the Volumes section, click <gui>Unmount Volume</gui>. Then click
55- <gui>Format Volume</gui>.</p>
56- </item>
57- <item>
58- <p>In the window that pops up, choose a filesystem <gui>Type</gui> for the
59- disk.</p>
60- <p>If you use the disk on Windows and Mac OS computers in addition to Linux
61- computers, choose <gui>FAT</gui>. If you only use it on Windows, <gui>NTFS</gui>
62- may be a better option. A brief description of the <gui>file system type</gui>
63- will be presented as a label.</p>
64- </item>
65- <item>
66- <p>Give the disk a name and click <gui>Format</gui> to begin wiping the disk.</p>
67- </item>
68- <item>
69- <p>Once the formatting has finished, <gui>safely remove</gui> the disk. It
70- should now be blank and ready to use again.</p>
71- </item>
72-</steps>
73-
74-<note style="warning">
75- <title>Formatting a disk does not securely delete your files</title>
76- <p>Formatting a disk is not a completely secure way of wiping all of its
77- data. A formatted disk will not appear to have files on it, but it is
78- possible that special recovery software could retrieve the files. If you
79- need to securely delete the files, you will need to use a command-line
80- utility, such as <app>shred</app>.</p>
81-</note>
82+<p>
83+</p>
84+ </item>
85+
86+
87+ <item>
88+ <p>Click the menu button and then click <gui>Format Disk...</gui>. The <gui>Format Disk</gui> window opens.</p>
89+ </item>
90+
91+ <item>
92+ <p>If you want to securely wipe the data from the disk, select <gui>Overwrite existing data with zeroes</gui>
93+ from the <gui>Erase</gui> dropdown list.</p>
94+ </item>
95+
96+ <item>
97+ <p>Click <gui>Format...</gui>.</p>
98+ </item>
99+
100+ <item>
101+ <p>In the window that opens click <gui>Format</gui> to begin wiping the disk.
102+ Once the formatting has finished the disk contents will be listed as "Unallocated Space".</p>
103+ </item>
104+</steps>
105+
106+<p>In order to reuse the wiped disk you must create one or more partitions.
107+The simplest case is where you create one partition that fills the whole disk:</p>
108+
109+<steps>
110+
111+ <item>
112+ <p>Open the <app>Disks</app> application from the <gui>Dash</gui>.</p>
113+ </item>
114+
115+ <item>
116+ <p>Select the disk from the list on the left.</p>
117+ </item>
118+
119+ <item>
120+ <p>Click the <gui>+</gui> button. The <gui>Create Partition</gui> window opens.</p>
121+ </item>
122+
123+ <item>
124+ <p>Type a name for the partition into the <gui>Name</gui> field.</p>
125+ </item>
126+
127+ <item>
128+ <p>Click <gui>Create</gui> to create the partition. You can now store data on the disk.</p>
129+ </item>
130+
131+</steps>
132+
133
134 </page>

Subscribers

People subscribed via source and target branches