Attachment 55388 Details for Bug 17267 – Bug 17267 - Document koha-create --adminuser

[patch] Bug 17267 - Document koha-create --adminuser

Bug-17267---Document-koha-create---adminuser.patch (text/plain), 2.50 KB, created by Liz Rea on 2016-09-09 03:35:43 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Liz Rea

Created: 2016-09-09 03:35:43 UTC

Size: 2.50 KB

patch

obsolete

>From 064ded3901ced0acbae5087b0386da1a322bc8bf Mon Sep 17 00:00:00 2001
>From: Magnus Enger <magnus@libriotech.no>
>Date: Thu, 8 Sep 2016 14:55:58 +0200
>Subject: [PATCH] Bug 17267 - Document koha-create --adminuser
>
>A description of --adminuser was missing from debian/docs/koha-create.xml
>This patch adds a description in the Options section, as well as under
>DEFAULTSQL in the list of configuration variables.
>
>To test:
>Run these commands and look at the formatted man page:
>$ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
>  debian/docs/koha-create.xml
>$ man -l koha-create.8
>
>Make sure this test passes:
>$ prove -v xt/verify-debian-docbook.t
>
>Signed-off-by: Liz Rea <liz@catalyst.net.nz>
>Edited commit message to fix typo - koha-mysql -> koha-create as that's what we're testing. :)
>---
> debian/docs/koha-create.xml | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
>diff --git a/debian/docs/koha-create.xml b/debian/docs/koha-create.xml
>index a485ba8..aad649a 100644
>--- a/debian/docs/koha-create.xml
>+++ b/debian/docs/koha-create.xml
>@@ -100,6 +100,13 @@
>     </varlistentry>
> 
>     <varlistentry>
>+      <term><option>--adminuser</option></term>
>+      <listitem>
>+        <para>Specify the borrowernumber of the user that should have a new, random password set as part of setting up the new instance. The password will be reported as part of the output of the current script. If --adminuser is not specified, the user with borrowernumber = 1 will be updated. If an SQL file is not used to populate the database of the newly created instance, no admin user will be created.</para>
>+      </listitem>
>+    </varlistentry>
>+
>+    <varlistentry>
>       <term><option>--marcflavor</option></term>
>       <listitem>
>         <para>Specifies format of MARC records to be indexed by Zebra. Corresponds to the ZEBRA_MARC_FORMAT config file variable.</para>
>@@ -258,6 +265,7 @@
>         <term><option>DEFAULTSQL</option></term>
>         <listitem>
>           <para>An SQL file (compressed with gzip) that can be fed  to  mysql(1) to  initialize the database after it has been created.  Might be created using koha-dump-defaults(8).</para>
>+          <para>If the SQL file contains users, the user with borrowernumber = 1 will have a new, random password set. This password will be reported in the output of the script. If another user than borrowernumber 1 should have its password set, the borrowernumber of this user can be set with the --adminuser command line option.</para>
>         </listitem>
>       </varlistentry>
> 
>-- 
>1.9.1

Actions: View | Diff | Splinter Review

Attachments on bug 17267: 55339 | 55388 | 55396