Bug 1314876 - Fix issues with grub2-tools man and info content (docs only)
Summary: Fix issues with grub2-tools man and info content (docs only)
Keywords:
Status: CLOSED EOL
Alias: None
Product: Fedora
Classification: Fedora
Component: grub2
Version: 25
Hardware: All
OS: All
low
low
Target Milestone: ---
Assignee: Peter Jones
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-03-04 18:05 UTC by Noel McLoughlin
Modified: 2017-12-12 11:00 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-12-12 11:00:40 UTC
Type: Bug


Attachments (Terms of Use)

Description Noel McLoughlin 2016-03-04 18:05:56 UTC
Description of problem:

Few issues with grub2-tools info and man.

1. grub2-mkstandalone man/info pages do not explain the 'SOURCE...' option. 

2. grub2-mkstandalone will generate a large 8M image for grubx64-efi format  by default which is slow to transfer over TFTP (see #1314744). Maybe we should explicitly recommend compression or drop some hints via example(s).

3. The following use a man3 template which is bit confusing.

man 1 grub2-mkstandalone
man 1 grub2-mkfont
man 1 grub2-mklayout
man 1 grub2-mknetdir 
man 1 grub2-mkpasswd-pbkdf2

4. The grub2-mknetdir command is not documented anywhere.


Version-Release number of selected component (if applicable):

grub2-tools-2.02-0.25.fc23.x86_64


How reproducible:

Always


Steps to Reproduce:

N/A 

Actual results:


Expected results:

1. Please explain the important 'SOURCE...' option for grub2-mkstandalone.
2. Consider recommending compression for EFI-network boot images.
3. Fix the man page metadata.
4. Update the grub2-mknetdir info/man documentation to explain usage/goals.


Additional info:

Comment 1 Noel McLoughlin 2016-03-04 18:07:43 UTC
Just to clarify this is ticket on documentation not functionality.

Comment 2 Jan Kurik 2016-07-26 04:55:35 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 25 development cycle.
Changing version to '25'.

Comment 3 Fedora End Of Life 2017-11-16 18:39:20 UTC
This message is a reminder that Fedora 25 is nearing its end of life.
Approximately 4 (four) weeks from now Fedora will stop maintaining
and issuing updates for Fedora 25. It is Fedora's policy to close all
bug reports from releases that are no longer maintained. At that time
this bug will be closed as EOL if it remains open with a Fedora  'version'
of '25'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version'
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not
able to fix it before Fedora 25 is end of life. If you would still like
to see this bug fixed and are able to reproduce it against a later version
of Fedora, you are encouraged  change the 'version' to a later Fedora
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's
lifetime, sometimes those efforts are overtaken by events. Often a
more recent Fedora release includes newer upstream software that fixes
bugs or makes them obsolete.

Comment 4 Fedora End Of Life 2017-12-12 11:00:40 UTC
Fedora 25 changed to end-of-life (EOL) status on 2017-12-12. Fedora 25 is
no longer maintained, which means that it will not receive any further
security or bug fix updates. As a result we are closing this bug.

If you can reproduce this bug against a currently maintained version of
Fedora please feel free to reopen this bug against that version. If you
are unable to reopen this bug, please file a new report against the
current release. If you experience problems, please add a comment to this
bug.

Thank you for reporting this bug and we are sorry it could not be fixed.


Note You need to log in before you can comment on or make changes to this bug.