Mailinglist Archive: opensuse-bugs (4174 mails)

< Previous Next >
[Bug 515020] New: gnome-session/gnome-session-save man page issues
  • From: bugzilla_noreply@xxxxxxxxxx
  • Date: Sun, 21 Jun 2009 01:23:35 -0600
  • Message-id: <bug-515020-21960@xxxxxxxxxxxxxxxxxxxxxxxx/>
http://bugzilla.novell.com/show_bug.cgi?id=515020


Summary: gnome-session/gnome-session-save man page issues
Classification: openSUSE
Product: openSUSE 11.2
Version: Factory
Platform: All
OS/Version: Other
Status: NEW
Severity: Normal
Priority: P5 - None
Component: GNOME
AssignedTo: bnc-team-gnome@xxxxxxxxxxxxxxxxxxxxxx
ReportedBy: gp@xxxxxxxxxx
QAContact: qa@xxxxxxx
Found By: Product Management


Trying to save my current session in GNOME to be restored upon my
next login has proven not to be as straightforward as I would have
hoped. But that's a different story. :-)

This report is about the documentation, in the form of man pages.

Specifically, after I found gnome-session-save and that did not
actually end up doing what I had hoped for (namely saving a session
to be restarted automatically upon next login), I consulted

man gnome-session-save

and noticed that this does not document where the session actually
is saved. This would normally go under the FILES section of the man
page (see man bash for an example).

Now,

man gnome-session

tries to document some of these paths, but the documentation of
--autostart=DIR refers to /desktop/gnome/session/default_session
(which is not an existing path on my system) and --default-session-key=KEY
refers to the same directory.

After a while I realized that these are not actually supposed to be
paths in my file system, even though they are refered to as DIR. This
is less confusing for --default-session-key=KEY which indeeds refers
to "GConf key", but --autostart=DIR really makes one thing this is a
reference to a regular directory.

Suggested documentation / usability fixes:

1. Enhance gnome-session-save man page with FILES section or other
reference on where the session actually is going to be saved.

2. Clarify --autostart=DIR description in gnome-session man page to
avoid confusion with directory (starting at /).

3. Add gconf-editor to the SEE ALSO sections of these two man pages.

Each of these three would have helped me, and I am sure will help others
in the future. If you would prefer me to split this report into three,
one each for the fixes suggested, I'll happily do so.

--
Configure bugmail: http://bugzilla.novell.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.

< Previous Next >
This Thread
  • No further messages