Date: Wed, 9 May 2012 14:24:39 +0000 (UTC) From: Grzegorz Bernacki <gber@FreeBSD.org> To: src-committers@freebsd.org, svn-src-projects@freebsd.org Subject: svn commit: r235174 - in projects/nand/usr.sbin: nandsim nandtool Message-ID: <201205091424.q49EOdMp087207@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: gber Date: Wed May 9 14:24:39 2012 New Revision: 235174 URL: http://svn.freebsd.org/changeset/base/235174 Log: nandfs: man pages style fix Obtained from: Semihalf Supported by: FreeBSD Foundation, Juniper Networks Modified: projects/nand/usr.sbin/nandsim/nandsim.8 projects/nand/usr.sbin/nandtool/nandtool.8 Modified: projects/nand/usr.sbin/nandsim/nandsim.8 ============================================================================== --- projects/nand/usr.sbin/nandsim/nandsim.8 Wed May 9 14:19:06 2012 (r235173) +++ projects/nand/usr.sbin/nandsim/nandsim.8 Wed May 9 14:24:39 2012 (r235174) @@ -88,9 +88,9 @@ .Ic help .Op Fl v .Sh COMMAND DESCRIPTION -Controllers and chips are arranged into a simple hierarchy. There can be up to -4 controllers configured, each with 4 chip select (CS) lines. A given chip is -connected to one of the chip selects. +Controllers and chips are arranged into a simple hierarchy. +There can be up to 4 controllers configured, each with 4 chip select (CS) lines. +A given chip is connected to one of the chip selects. .Pp Controllers are specified as .Aq ctrl_no ; @@ -103,7 +103,8 @@ Gets controller(s) status. If or .Fl -all flag is specified - command will print status of every controller -currently available. Optional flag +currently available. +Optional flag .Fl v causes printing complete information about the controller, and all chips attached to it. @@ -123,12 +124,12 @@ full stop-start cycle in order to take e .It nandsim start ... .El .It Ic mod -Alters simulator parameters on-the-fly. If controller number and CS -pair is not specified, the general simulator parameters (not -specific to a controller or a chip) will be modified. Changing -chip's parameters requires specifying both controller number and CS -to which the given chip is connected. Parameters which can be -altered: +Alters simulator parameters on-the-fly. +If controller number and CS pair is not specified, the general +simulator parameters (not specific to a controller or a chip) will be modified. +Changing chip's parameters requires specifying both controller number and CS +to which the given chip is connected. +Parameters which can be altered: .Pp General simulator related: .Bl -tag -width flag @@ -160,12 +161,13 @@ will list parameters which can be altere .El .Bl -tag -width periphlist .It Ic bb -Marks/unmarks a specified block as bad. To mark/unmark the bad -condition an a block, the following parameters have to be supplied: -controller number, CS number, and at least one block number. It is -possible to specify multiple blocks, by separating blocks numbers -with a comma. The following options can be used for the 'bb' -command: +Marks/unmarks a specified block as bad. +To mark/unmark the bad condition an a block, the following parameters +have to be supplied: controller number, CS number, and at least one +block number. +It is possible to specify multiple blocks, by separating blocks numbers +with a comma. +The following options can be used for the 'bb' command: .Bl -tag -width flag .It Fl U unmark the bad previously marked block as bad. @@ -193,12 +195,13 @@ Stops an already started controller; if supplied, attempts to stop all currently working controllers. .It Ic destroy Removes existing active chip/controller and its configuration from -memory and releases the resources. Specifying flag +memory and releases the resources. +Specifying flag .Fl a or .Fl -all -causes removal of every chip and controller. Controller must be -stopped in order to be destroyed. +causes removal of every chip and controller. +Controller must be stopped in order to be destroyed. .It Ic error Directly overwrites a certain number of bytes in the specified page at a given offset with a supplied pattern (which mimics the @@ -208,8 +211,8 @@ Prints synopsis, .Fl v gives more verbose output. .It Ic freeze -Stops simulation of given controller (simulates power-loss). All -commands issues to any chip on this controller are ignored. +Stops simulation of given controller (simulates power-loss). +All commands issues to any chip on this controller are ignored. .El .Sh SEE ALSO .Xr nand 4 , Modified: projects/nand/usr.sbin/nandtool/nandtool.8 ============================================================================== --- projects/nand/usr.sbin/nandtool/nandtool.8 Wed May 9 14:19:06 2012 (r235173) +++ projects/nand/usr.sbin/nandtool/nandtool.8 Wed May 9 14:24:39 2012 (r235174) @@ -48,7 +48,8 @@ Read pages from NAND device. .It Cm write Ns Write pages to NAND device. .It Cm erase Ns -Erase blocks. Requires offset aligned to block granularity. +Erase blocks. +Requires offset aligned to block granularity. .It Cm info Ns Get information about NAND chip (page size, block size, OOB area size, chip size and media size) @@ -62,7 +63,8 @@ Get usage info. .Sh COMMAND read .Pp The following operands are available for -.Va nandtool read +.Nm +.Cm read command: .Bl -tag -width ".Cm of Ns = Ns Ar file" .It Cm dev Ns = Ns Ar <path> @@ -87,7 +89,8 @@ Count of objects (pages, blocks, bytes). .Bl -tag -width ".Cm of Ns = Ns Ar file" .Pp The following operands are available for -.Va nandtool readoob +.Nm +.Cm readoob command: .Pp .It Cm dev Ns = Ns Ar <path> @@ -100,7 +103,8 @@ Output file path, optional. .Sh COMMAND write .Bl -tag -width ".Cm of Ns = Ns Ar file" The following operands are available for -.Va nandtool write +.Nm +.Cm write command: .It Cm dev Ns = Ns Ar <path> Path to NAND device node. @@ -117,7 +121,8 @@ Input file path. .Sh COMMAND writeoob .Bl -tag -width ".Cm of Ns = Ns Ar file" The following operands are available for -.Va nandtool writeoob +.Nm +.Cm writeoob command: .It Cm dev Ns = Ns Ar <path> Path to NAND device node. @@ -129,7 +134,8 @@ Input file path. .Sh COMMAND erase .Bl -tag -width ".Cm of Ns = Ns Ar file" The following operands are available for -.Va nandtool erase +.Nm +.Cm erase command: .It Cm dev Ns = Ns Ar <path> Path to NAND device node. @@ -150,7 +156,8 @@ When no other arguments are provided the .Sh COMMAND info .Bl -tag -width ".Cm of Ns = Ns Ar file" There is only one operand available for -.Va nandtool info +.Nm +.Cm info command: .It Cm dev Ns = Ns Ar <path> Path to NAND device node. @@ -158,7 +165,8 @@ Path to NAND device node. .Sh COMMAND help .Bl -tag -width ".Cm of Ns = Ns Ar file" There is only one operand available for -.Va nandtool help +.Nm +.Cm help command: .Pp .It Cm topic Ns = Ns Ar <name> @@ -169,9 +177,11 @@ Help topic. If the supplied argument .Ar dev points to a device node other than gnand<num> or gnand.raw<num> both -.Va nandtool readoob +.Nm +.Cm readoob and -.Va nandtool writeoob +.Nm +.Cm writeoob return error. .Sh SEE ALSO .Xr gnand 4
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201205091424.q49EOdMp087207>