GNOME Bugzilla – Bug 695952
"How do I hibernate my computer?" page is outdated
Last modified: 2014-03-24 16:40:53 UTC
This page: https://help.gnome.org/users/gnome-help/3.7/power-hibernate.html.en describes how to enable Hibernate in the shell menu with the creation of a .pkla file. But Polkit has switched from pkla to Javascript. Anyway, the correct way to get Hibernate is to install gnome-shell-extension-alternative-status-menu and then use gsettings to change org.gnome.shell.extensions.alternative-status-menu allow-hibernate to true. We probably don't want to describe that in the user docs. (And I don't know how to get it to work at all using the extensions.gnome.org version; I've only managed to get Hibernate when installed by a package manager to /usr/share/gnome-shell/extensions.)
Created attachment 241516 [details] [review] Added the steps that enables the hibernate option using gnome shell extension
Hi, I have just started contributing to gnome-docs and this was my first patch. I require some help with writing correct instructions. It would be great if somebody could guide me in writing the instructions for resolving this bug. Thank you!
Comment on attachment 241516 [details] [review] Added the steps that enables the hibernate option using gnome shell extension >From: sowmya <sowcat@sowmya.(none)> That email address is incorrect. >Subject: [PATCH] Add the steps that enables hibernate option using > gnome-shell extension Personal preference would be "Describe how to hibernate the machine using..." or such. "Add the steps that enables" is a bit long plus has a grammar mistake. Might be worth to mention bug 695952 here too. >+ <p>Install gnome-shell-extension-alternative-status-menu.</p> But how? I'd recommend to use Mallard's install action at least (see http://projectmallard.org/1.0/mal_attr_link.html ), plus a fallback href attribute to https://extensions.gnome.org/extension/5/alternative-status-menu/ (I hope that link is kind of stable). >+ <p>Use gsettings to change org.gnome.shell.extensions.alternative-status-menu allow-hibernate to true.</p> Where can I find gsettings. And as it's a command line tool, how do I "change" exactly? Don't expect me to know anything please. :) Hint: I'd check for other instructions that use gsettings (you could use the "grep" command in your checkout of the gnome-help to find other examples, like ' grep -r gsettings . ') and would try to reuse instructions if possible, which saves time for translators if some strings are re-used whenever it makes sense. >+<p> The steps mentioned above are the currently known methods to have hibernate option </p> Please use fullstops and avoid whitespace at the end of sentences. Plus I only saw *one* method described above, so wondering why you write "methods". "to have hibernate option" does not sound write, you would either need an article here (*the* hibernate option), but even better I'd describe an action (to get the Hibernate option displayed in...).
(In reply to comment #3) > (From update of attachment 241516 [details] [review]) > >From: sowmya <sowcat@sowmya.(none)> > > That email address is incorrect. Sowmya, to tell git your email address, you can run this command: git config --global user.email "youremailhere@gmail.com" If you wan to fix the author/email of your most recent commit you can then run this: git commit --amend --reset-author > > >+ <p>Install gnome-shell-extension-alternative-status-menu.</p> > > But how? > I'd recommend to use Mallard's install action at least (see > http://projectmallard.org/1.0/mal_attr_link.html ), plus a fallback href > attribute to https://extensions.gnome.org/extension/5/alternative-status-menu/ > (I hope that link is kind of stable). The problem with that is that extensions downloaded from extensions.gnome.org are going to use a local gsettings database, so the process for changing the setting will be different than if the extension was installed by a distribution (which would allow you to edit it with e.g. Dconf Editor). Honestly I haven't figured out how to do it properly.
Thank you Andre and Micheal for your review. I will incorporate all your suggestions in my next patch.
Hi Sowmya, are you still working on this page?
Hi Kate, I am sorry. I am not working on this bug anymore. Someone else can take it up
Way to fix this: And there is no alternative-status-menu for 3.10, because 3.10 has the new status menu. You want https://extensions.gnome.org/extension/755/hibernate-status-button/ instead. (From dup bug 721904)
*** Bug 721904 has been marked as a duplicate of this bug. ***
I've started working on this.
Created attachment 268879 [details] [review] Patch to install and use Hibernate button from https://extensions.gnome.org/extension/755/hibernate-status-button/ The page describes how to install the button from website https://extensions.gnome.org/extension/755/hibernate-status-button/ Questions: Should we be documenting on how to do this from the system as well? I think so actually, since URLs are ever changing, but I am not sure what's the right way to do this. I tried grepping for extensions, but came up with zilch. Should we be documenting the behaviour of how the button changes on pressing "Alt" in the power-hibernate page? If so we should be explaining "Hybrid Sleep" and would this be the right page to do that? With all that said, I think we should merge the power-hibernate page to shell-exit.page even though it'll increase the page way beyond the one screen-size mark(The page is already way beyond the one screen size mark, so this should be okay? ;) ) Please review.
(In reply to comment #11) > Should we be documenting on how to do this from the system as well? As far as I know, there is no way to install extensions from the system. > Should we be documenting the behaviour of how the button changes on pressing > "Alt" in the power-hibernate page? If so we should be explaining "Hybrid Sleep" > and would this be the right page to do that? Do you mean the Shut Down button which becomes Suspend? That should already be documented somewhere. > With all that said, I think we should merge the power-hibernate page to > shell-exit.page even though it'll increase the page way beyond the one > screen-size mark(The page is already way beyond the one screen size mark, so > this should be okay? ;) ) I think that would make the page too complex…
Review of attachment 268879 [details] [review]: ::: gnome-help/C/power-hibernate.page @@ +85,3 @@ + <p>You could also install the + <link href="https://extensions.gnome.org/extension/755/hibernate-status-button/"> + <app>Hibernate Status Button</app></link> extension from the <link href="https://extensions.gnome.org">GNOME Extensions website</link>:</p> Break the link before the link please. @@ +97,3 @@ + <item> + <p>You will be prompted to install the button. + Press <gui style="button">Install</gui>.</p> Reflow."Prompted" is not a nice word, try "you will be asked to confirm that you want to install the extension. Press "Install"" or "Press "Install" to install the extension." @@ +101,3 @@ + </steps> + + <p>The button will now be present in the system menu on the right side of the "be added to", not "be present in"
Created attachment 269575 [details] [review] Patch after review Thanks for taking time to review the patch, Kat. All changes have been made in this one. Strangely, the link did not flow to the next line on my system. I have checked this patch carefully and done all my reflows carefully, hopefully this one's ok.
> > Should we be documenting the behaviour of how the button changes on pressing > > "Alt" in the power-hibernate page? If so we should be explaining "Hybrid Sleep" > > and would this be the right page to do that? > > Do you mean the Shut Down button which becomes Suspend? That should already be > documented somewhere. > The Hybrid button also behaves in a similar manner to the Shut Down button. It becomes the Hybrid-Sleep button on pressing "Alt". ref: https://extensions.gnome.org/extension/755/hibernate-status-button/ (I also tested it to confirm the behaviour.) > > With all that said, I think we should merge the power-hibernate page to > > shell-exit.page even though it'll increase the page way beyond the one > > screen-size mark(The page is already way beyond the one screen size mark, so > > this should be okay? ;) ) > > I think that would make the page too complex… Should we split up shell-exit page?
* At least one major distro is considering dropping pm-utils. I don't think there's much benefit to telling the user to check if hibernate works via the command line anyway. pm-utils could succeed on systems where the extension would fail (it seems to depend on logind), or vice versa if pm-utils doesn't exist. * The page suggests the user check if his swap partition is as large as available RAM, but doesn't explain what these are, let alone how to check their size.
(In reply to comment #15) > > > Should we be documenting the behaviour of how the button changes on pressing > > > "Alt" in the power-hibernate page? If so we should be explaining "Hybrid Sleep" > > > and would this be the right page to do that? > > > > Do you mean the Shut Down button which becomes Suspend? That should already be > > documented somewhere. > > > > The Hybrid button also behaves in a similar manner to the Shut Down button. It > becomes the Hybrid-Sleep button on pressing "Alt". ref: > https://extensions.gnome.org/extension/755/hibernate-status-button/ > (I also tested it to confirm the behaviour.) Yes, please do document this. If you can figure out what "Hybrid-Sleep" actually is, that would be even better (maybe bother the person who wrote the extention?). I would agree with Michael that the extension should take precedence over the commandline instructions, but I would say that you should leave them at the bottom for now (and it's always easy to remove them later if we need to).
(In reply to comment #17) > Yes, please do document this. If you can figure out what "Hybrid-Sleep" > actually is, that would be even better (maybe bother the person who wrote the > extention?). It's a mix of hibernate and sleep. Like sleep, your computer remains powered on, and you can wake it up by pressing on the keyboard. Like hibernate, everything gets written to disk, so it's slow. The point is that if your computer loses power during sleep, your work is still safe. (Useful for desktops, mainly.) http://www.thepowerbase.com/2012/10/linux-3-6-brings-hybrid-sleep-all-rejoice/ says it's fast and great, but I'm not sure if that author is correct: it's really slow for me. Try it out with 'systemctl hybrid-sleep'
Created attachment 270346 [details] [review] Document hybrid-sleep feature as well. Added the hybrid-sleep feature in a note. I feel we should either keep the pm-utils feature or remove it as moving it will affect the flow of the page since testing if hibernate works before enabling it seems nicer than the reverse.
Comment on attachment 270346 [details] [review] Document hybrid-sleep feature as well. (In reply to comment #19) > Created an attachment (id=270346) [details] [review] > Document hybrid-sleep feature as well. > > Added the hybrid-sleep feature in a note. Looks good to me (successfully reproduced the steps in 3.10) so I think this can get in.
Pushed to master in commit 45c51b1e07ff216db3e6ff9da5c7512dac2e5803