[Bug 1464852] [NEW] document /etc/grub.d/ templates

[Karl-Philipp Richter]

Public bug reported:

Although customization is possible by changing `/etc/default/grub` and
adding custom templates as described in `/etc/grub.d/README` it's
necessary to document the functions in the templates in `/etc/grub.d/`
(arguments, which constants are used, etc.). The fact that the bad
practice to not document shell code at all is common doesn't count.

ProblemType: Bug
DistroRelease: Ubuntu 15.04
Package: grub-efi 2.02~beta2-22ubuntu1
Uname: Linux 4.0.5-040005-generic x86_64
ApportVersion: 2.17.2-0ubuntu1.1
Architecture: amd64
Date: Sat Jun 13 13:00:14 2015
EcryptfsInUse: Yes
InstallationDate: Installed on 2015-04-20 (53 days ago)
InstallationMedia: Ubuntu-Server 14.10 "Utopic Unicorn" - Release amd64 (20141022.2)
ProcEnviron:
 TERM=xterm
 PATH=(custom, no user)
 XDG_RUNTIME_DIR=<set>
 LANG=de_DE.UTF-8
 SHELL=/bin/bash
SourcePackage: grub2
UpgradeStatus: Upgraded to vivid on 2015-04-24 (49 days ago)

** Affects: grub2 (Ubuntu)
     Importance: Undecided
         Status: New


** Tags: amd64 apport-bug vivid

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to grub2 in Ubuntu.
https://bugs.launchpad.net/bugs/1464852

Title:
  document /etc/grub.d/ templates

Status in grub2 package in Ubuntu:
  New

Bug description:
  Although customization is possible by changing `/etc/default/grub` and
  adding custom templates as described in `/etc/grub.d/README` it's
  necessary to document the functions in the templates in `/etc/grub.d/`
  (arguments, which constants are used, etc.). The fact that the bad
  practice to not document shell code at all is common doesn't count.

  ProblemType: Bug
  DistroRelease: Ubuntu 15.04
  Package: grub-efi 2.02~beta2-22ubuntu1
  Uname: Linux 4.0.5-040005-generic x86_64
  ApportVersion: 2.17.2-0ubuntu1.1
  Architecture: amd64
  Date: Sat Jun 13 13:00:14 2015
  EcryptfsInUse: Yes
  InstallationDate: Installed on 2015-04-20 (53 days ago)
  InstallationMedia: Ubuntu-Server 14.10 "Utopic Unicorn" - Release amd64 (20141022.2)
  ProcEnviron:
   TERM=xterm
   PATH=(custom, no user)
   XDG_RUNTIME_DIR=<set>
   LANG=de_DE.UTF-8
   SHELL=/bin/bash
  SourcePackage: grub2
  UpgradeStatus: Upgraded to vivid on 2015-04-24 (49 days ago)

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/grub2/+bug/1464852/+subscriptions