c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2024-12-26 11:19:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

zfs.8 has wrong description of "zfs program -t"

Browse Source 
The "-t" argument to "zfs program" specifies a limit on the number of
LUA instructions that can be executed.  The zfs.8 manpage has the wrong
description.  It should be updated to match what's in zfs-program.8

Also fix the formatting of the zfs help message.

Reviewed by: Allan Jude <allanjude@freebsd.org>
Reviewed-by: loli10K <ezomori.nozomu@gmail.com>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Matthew Ahrens <mahrens@delphix.com>
Closes #8410
This commit is contained in:
Matthew Ahrens 2019-02-26 11:15:28 -08:00 committed by Brian Behlendorf
parent 47d7ef5490
commit c568ab8d99
4 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cmd/zfs/zfs_main.c
View File

@ -21,7 +21,7 @@
/* /*
* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2018 by Delphix. All rights reserved. * Copyright (c) 2011, 2019 by Delphix. All rights reserved.
* Copyright 2012 Milan Jurik. All rights reserved. * Copyright 2012 Milan Jurik. All rights reserved.
* Copyright (c) 2012, Joyent, Inc. All rights reserved. * Copyright (c) 2012, Joyent, Inc. All rights reserved.
* Copyright (c) 2013 Steven Hartland. All rights reserved. * Copyright (c) 2013 Steven Hartland. All rights reserved.
@ -366,8 +366,8 @@ get_usage(zfs_help_t idx)
return (gettext("\tbookmark <snapshot> <bookmark>\n")); return (gettext("\tbookmark <snapshot> <bookmark>\n"));
case HELP_CHANNEL_PROGRAM: case HELP_CHANNEL_PROGRAM:
return (gettext("\tprogram [-jn] [-t <instruction limit>] " return (gettext("\tprogram [-jn] [-t <instruction limit>] "
"[-m <memory limit (b)>] <pool> <program file> " "[-m <memory limit (b)>]\n"
"[lua args...]\n")); "\t <pool> <program file> [lua args...]\n"));
case HELP_LOAD_KEY: case HELP_LOAD_KEY:
return (gettext("\tload-key [-rn] [-L <keylocation>] " return (gettext("\tload-key [-rn] [-L <keylocation>] "
"<-a | filesystem|volume>\n")); "<-a | filesystem|volume>\n"));

4
man/man8/zfs-program.8
View File

@ -8,7 +8,7 @@
.\" http://www.illumos.org/license/CDDL. .\" http://www.illumos.org/license/CDDL.
.\" .\"
.\" .\"
.\" Copyright (c) 2016, 2017 by Delphix. All Rights Reserved. .\" Copyright (c) 2016, 2019 by Delphix. All Rights Reserved.
.\" .\"
.Dd January 21, 2016 .Dd January 21, 2016
.Dt ZFS-PROGRAM 8 .Dt ZFS-PROGRAM 8
@ -59,7 +59,7 @@ determining if changes would succeed (zfs.check.*).
Without this flag, all pending changes must be synced to disk before a Without this flag, all pending changes must be synced to disk before a
channel program can complete. channel program can complete.
.It Fl t Ar instruction-limit .It Fl t Ar instruction-limit
Execution time limit, in number of Lua instructions to execute. Limit the number of Lua instructions to execute.
If a channel program executes more than the specified number of instructions, If a channel program executes more than the specified number of instructions,
it will be stopped and an error will be returned. it will be stopped and an error will be returned.
The default limit is 10 million instructions, and it can be set to a maximum of The default limit is 10 million instructions, and it can be set to a maximum of

21
man/man8/zfs.8
View File

@ -21,7 +21,7 @@
.\" .\"
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org> .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
.\" Copyright (c) 2011, 2017 by Delphix. All rights reserved. .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
.\" Copyright (c) 2014 by Adam Stevko. All rights reserved. .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
@ -302,8 +302,8 @@
.Nm .Nm
.Cm program .Cm program
.Op Fl jn .Op Fl jn
.Op Fl t Ar timeout .Op Fl t Ar instruction-limit
.Op Fl m Ar memory_limit .Op Fl m Ar memory-limit
.Ar pool script .Ar pool script
.Op Ar arg1 No ... .Op Ar arg1 No ...
.Nm .Nm
@ -4413,8 +4413,8 @@ Display the path's inode change time as the first column of output.
.Nm .Nm
.Cm program .Cm program
.Op Fl jn .Op Fl jn
.Op Fl t Ar timeout .Op Fl t Ar instruction-limit
.Op Fl m Ar memory_limit .Op Fl m Ar memory-limit
.Ar pool script .Ar pool script
.Op Ar arg1 No ... .Op Ar arg1 No ...
.Xc .Xc
@ -4446,11 +4446,12 @@ The program can be used to gather information such as properties and
determining if changes would succeed (zfs.check.*). determining if changes would succeed (zfs.check.*).
Without this flag, all pending changes must be synced to disk before Without this flag, all pending changes must be synced to disk before
a channel program can complete. a channel program can complete.
.It Fl t Ar timeout .It Fl t Ar instruction-limit
Execution time limit, in milliseconds. Limit the number of Lua instructions to execute.
If a channel program executes for longer than the provided timeout, it will If a channel program executes more than the specified number of instructions,
be stopped and an error will be returned. it will be stopped and an error will be returned.
The default timeout is 1000 ms, and can be set to a maximum of 10000 ms. The default limit is 10 million instructions, and it can be set to a maximum of
100 million instructions.
.It Fl m Ar memory-limit .It Fl m Ar memory-limit
Memory limit, in bytes. Memory limit, in bytes.
If a channel program attempts to allocate more memory than the given limit, If a channel program attempts to allocate more memory than the given limit,

4
tests/zfs-tests/tests/functional/cli_root/zfs_program/zfs_program_json.ksh
View File

@ -16,6 +16,7 @@
# #
# Copyright (c) 2018 Datto Inc. # Copyright (c) 2018 Datto Inc.
# Copyright (c) 2019 by Delphix. All rights reserved.
# #
. $STF_SUITE/include/libtest.shlib . $STF_SUITE/include/libtest.shlib
@ -111,7 +112,8 @@ typeset -a neg_cmds=("-Z")
typeset -a neg_cmds_out=( typeset -a neg_cmds_out=(
"invalid option 'Z' "invalid option 'Z'
usage: usage:
program [-jn] [-t <instruction limit>] [-m <memory limit (b)>] <pool> <program file> [lua args...] program [-jn] [-t <instruction limit>] [-m <memory limit (b)>]
<pool> <program file> [lua args...]
For the property list, run: zfs set|get For the property list, run: zfs set|get