nbs, and lc.
ClosedPublic
Actions

Authored by pfg on Dec 2 2016, 1:41 AM.

Details

Reviewers

Group Reviewers

Commits

rS309524: indent(1): remove unneeded comma.
rS309451: Document undocumented indent(1) options badp/nbadp, bs/nbs, and lc.

Summary

Improve manpage for indent(1)

Change from Piotr Stefaniak:
https://github.com/pstef/freebsd_indent/commit/a6652c3f330e26cd96c4ed337905b2ca4c42e64b

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 6124
Build 6381: arc lint + arc unit

Event Timeline

pfg updated this revision to Diff 22657.Dec 2 2016, 1:41 AM

pfg retitled this revision from to Document undocumented indent(1) options badp/nbadp, bs/nbs, and lc..

pfg updated this object.

pfg edited the test plan for this revision. (Show Details)

pfg added a reviewer: wblock.

pfg added a subscriber: pstef.

Herald added a reviewer: manpages. · View Herald TranscriptDec 2 2016, 1:41 AM

Herald added a subscriber: imp. · View Herald Transcript

A few corrections. Running textproc/igor and mandoc -Tlint will find errors in man pages like this.

usr.bin/indent/indent.1
153	You need a line break after the sentence stop here.
196	Another line break here.
342	Another... well, you guessed it. ;-)

Use a newline when finishing a sentence.

Herald edited edge metadata. · View Herald TranscriptDec 2 2016, 4:49 PM

Done, thanks!

usr.bin/indent/indent.1
151	I am wondering, is it OK to start a line with a comma? Perhaps this comma is also reduntant.

Closed by commit rS309451: Document undocumented indent(1) options badp/nbadp, bs/nbs, and lc. (authored by pfg). · Explain WhyDec 3 2016, 12:24 AM

This revision was automatically updated to reflect the committed changes.

bjk added a subscriber: bjk.Dec 3 2016, 11:28 PM

bjk added inline comments.

usr.bin/indent/indent.1
151	Generally the comma would go on the previous line, with a space between "bad" and the comma. I forget whether the version as-committed will end up rendering with a space before the comma. You're also right that this particular comma is not strictly needed.

wblock added inline comments.Dec 12 2016, 3:11 PM

usr.bin/indent/indent.1
151	When spoken, it doesn't quite sound right without the pause represented by the comma. To render correctly, the comma needs to be on the same line as the .Fl macro: .Fl bad , The space before the comma there is a delimiter to the macro. It renders the "bad" as the flag, then adds the comma without a space: bad, It's hard to think of any time a line beginning with a comma with be rendered correctly.

Revision Contents
Changeset List

Path

Size

usr.bin/

indent/

indent.1

20 lines

Diff 22675

View Options

usr.bin/indent/indent.1

Context not available.

	$FreeBSD$	$FreeBSD$
	$FreeBSDde$	$FreeBSDde$
	basiert auf: r41912	basiert auf: r42527
	-->	-->
	<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="geom">	<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="geom">
	<info><title>GEOM: Modulares Framework zur	<info><title>GEOM: Modulares Framework zur
Context not available.
	</sect2>	</sect2>
	</sect1>	</sect1>

		<sect1 xml:id="geom-raid">
		<info>
		<title>Software RAID</title>

		<authorgroup>
		<author>
		<personname>
		<firstname>Warren</firstname>
		<surname>Block</surname>
		</personname>
		<contrib>Beigetragen von </contrib>
		</author>
		</authorgroup>
		<authorgroup>
		<author>
		<personname>
		<firstname>Björn</firstname>
		<surname>Heidotting</surname>
		</personname>
		<contrib>Übersetzt von </contrib>
		</author>
		</authorgroup>
		</info>

		<indexterm>
		<primary><acronym>GEOM</acronym></primary>
		</indexterm>
		<indexterm>
		<primary>Software RAID</primary>
		<secondary>Hardware RAID</secondary>
		</indexterm>

		<para>Einige Motherboards und Erweiterungskarten besitzen ein
		<acronym>ROM</acronym>, das dem Rechner erlaubt von einem
		<acronym>RAID</acronym>-Array zu booten. Nach dem Booten wird
		der Zugriff auf das <acronym>RAID</acronym>-Array durch die
		Software auf dem Prozessor des Rechners abgewickelt. Dieses
		<quote>Hardware-unterstützte Software-<acronym>RAID</acronym></quote>
		ist nicht abhängig von einem bestimmten Betriebssystem. Sie
		funktionieren bereits, noch bevor das Betriebssystem geladen
		wird.</para>

		<para>Abhängig von der verwendeten Hardware werden mehrere Arten
		von <acronym>RAID</acronym> unterstützt. Eine vollständige
		Liste finden Sie in &man.graid.8;.</para>

		<para>&man.graid.8; benötigt das <filename>geom_raid.ko</filename>
		Kernelmodul, welches beginnend mit &os; 9.1 im
		<filename>GENERIC</filename>-Kernel enthalten ist. Bei Bedarf
		kann es manuell mit <command>graid load</command> geladen
		werden.</para>

		<sect2 xml:id="geom-raid-creating">
		<title>Ein Array erstellen</title>

		<para>Geräte mit Software-<acronym>RAID</acronym> haben oft ein
		Menü, das über eine bestimmte Tastenkombination beim Booten
		aufgerufen werden kann. Das Menü kann verwendet werden, um
		<acronym>RAID</acronym>-Arrays zu erstellen und zu löschen.
		Mit &man.graid.8; können Arrays auch direkt von der
		Kommandozeile erstellt werden.</para>

		<para><command>graid label</command> wird verwendet, um ein
		neues Array zu erstellen. Das Motherboard in diesem Beispiel
		besitzt einen &intel; Software-<acronym>RAID</acronym>
		Chipsatz, so dass das Metadatenformat von &intel; angegeben
		wird. Das neue Array bekommt den Namen (Label)
		<filename>gm0</filename>, verhält sich als Spiegel
		(<acronym>RAID1</acronym>) und verwendet die Laufwerke
		<filename>ada0</filename> und
		<filename>ada1</filename>.</para>

		<caution>
		<para>Bei der Erstellung des Arrays wird etwas Platz auf den
		Laufwerken überschrieben. Sichern Sie zuvor alle
		vorhandenen Daten!</para>
		</caution>

		<screen>&prompt.root; <userinput>graid label Intel gm0 RAID1 ada0 ada1</userinput>
		GEOM_RAID: Intel-a29ea104: Array Intel-a29ea104 created.
		GEOM_RAID: Intel-a29ea104: Disk ada0 state changed from NONE to ACTIVE.
		GEOM_RAID: Intel-a29ea104: Subdisk gm0:0-ada0 state changed from NONE to ACTIVE.
		GEOM_RAID: Intel-a29ea104: Disk ada1 state changed from NONE to ACTIVE.
		GEOM_RAID: Intel-a29ea104: Subdisk gm0:1-ada1 state changed from NONE to ACTIVE.
		GEOM_RAID: Intel-a29ea104: Array started.
		GEOM_RAID: Intel-a29ea104: Volume gm0 state changed from STARTING to OPTIMAL.
		Intel-a29ea104 created$
		GEOM_RAID: Intel-a29ea104: Provider raid/r0 for volume gm0 created.</screen>

		<para>Eine Statusabfrage zeigt, dass der neue Spiegel
		einsatzbereit ist:</para>

		<screen>&prompt.root; <userinput>graid status</userinput>
		Name Status Components
		raid/r0 OPTIMAL ada0 (ACTIVE (ACTIVE))
		ada1 (ACTIVE (ACTIVE))</screen>

		<para>Das Array-Gerät erscheint in
		<filename>/dev/raid/</filename>. Das erste Gerät heißt
		<filename>r0</filename>. Falls weitere Geräte vorhanden sind
		heißen diese <filename>r1</filename>, <filename>r2</filename>
		und so weiter.</para>

		<para>Das <acronym>BIOS</acronym>-Menü einiger Geräte erstellt
		Arrays mit Sonderzeichen im Namen. Um Probleme mit diesen
		Sonderzeichen zu vermeiden, werden einfache numerische Namen
		wie <filename>r0</filename> vergeben. Um das tatsächliche
		Label anzuzeigen, wie <filename>gm0</filename> im obigen
		Beispiel, benutzen Sie &man.sysctl.8;:</para>

		<screen>&prompt.root; <userinput>sysctl kern.geom.raid.name_format=1</userinput></screen>
		</sect2>

		<sect2 xml:id="geom-graid-volumes">
		<title>Mehrere Volumes</title>

		<para>Einige Software-<acronym>RAID</acronym> Geräte
		unterstützen mehr als ein <emphasis>Volume</emphasis> pro
		Array. Volumes funktionieren wie Festplatten, dass heißt der
		Platz auf den Laufwerken kann auf unterschiedliche Weise
		geteilt und genutzt werden. Intels
		Software-<acronym>RAID</acronym> Geräte unterstützen
		beispielsweise zwei Volumes. In diesem Beispiel wird ein
		40 GB Spiegel verwendet um das Betriebssystem zu
		speichern, gefolgt von einem 20 GB
		<acronym>RAID0</acronym> (Stripe) Volume für die schnelle
		Speicherung von temporären Daten.</para>

		<screen>&prompt.root; <userinput>graid label -S 40G Intel gm0 RAID1 ada0 ada1</userinput>
		&prompt.root; <userinput>graid add -S 20G gm0 RAID0</userinput></screen>

		<para>Volumes erscheinen unter <filename>/dev/raid/</filename>
		als zusätzliche Einträge
		<filename>r<replaceable>X</replaceable></filename>. Ein
		Array mit Volumes wird als <filename>r0</filename> und
		<filename>r1</filename>.</para>

		<para>Lesen Sie &man.graid.8; um die Anzahl der Volumes zu
		ermitteln, die von den verschiedenen
		Software-<acronym>RAID</acronym> Geräten unterstützt
		wird.</para>
		</sect2>

		<sect2 xml:id="geom-graid-converting">
		<title>Ein einzelnes Laufwerk zu einem Spiegel
		konvertieren</title>

		<para>Unter bestimmten Umständen ist es möglich, ein
		bestehendes Laufwerk ohne Neuformatierung zu einem
		&man.graid.8; Array zu konvertieren. Um Datenverlust
		bei der Konvertierung zu vermeiden, müssen die vorhandenen
		Laufwerke folgende Mindestanforderungen erfüllen:</para>

		<itemizedlist>
		<listitem>
		<para>Das Laufwerk muss mit <acronym>MBR</acronym>
		partitioniert werden. <acronym>GPT</acronym> oder andere
		Partitionierungsschemata funktionieren nicht, da durch
		&man.graid.8; die Metadaten am Ende des Laufwerks
		überschieben und beschädigt werden.</para>
		</listitem>

		<listitem>
		<para>Am Ende des Laufwerks muss genügend freier Platz zur
		Verfügung stehen, um die &man.graid.8; Metadaten zu
		speichern. Die Metadaten variieren in der Größe, es
		werden jedoch mindestens 64 MB freier Speicherplatz
		empfohlen.</para>
		</listitem>
		</itemizedlist>

		<para>Wenn das Laufwerk diese Anforderungen erfüllt, erstellen
		Sie zuerst eine vollständige Sicherung. Erzeugen Sie dann
		einen Spiegel mit diesem einen Laufwerk:</para>

		<screen>&prompt.root; <userinput>graid label Intel gm0 RAID1 ada0 NONE</userinput></screen>

		<para>Die Metadaten von &man.graid.8; werden in den ungenutzten
		Raum am Ende des Laufwerks geschrieben. Ein zweites Laufwerk
		kann nun in den Spiegel eingefügt werden:</para>

		<screen>&prompt.root; <userinput>graid insert raid/r0 ada1</userinput></screen>

		<para>Die Daten von dem ersten Laufwerk werden direkt auf das
		zweite Laufwerk kopiert. Der Spiegel wird im eingeschränkten
		Zustand laufen, bis der Kopiervorgang abgeschlossen
		ist.</para>
		</sect2>

		<sect2 xml:id="geom-graid-inserting">
		<title>Neue Laufwerke zum Array hinzufügen</title>

		<para>Laufwerke in einem Array können für ausgefallene oder
		fehlende Laufwerke eingesetzt werden. Falls es keine
		ausgefallenen oder fehlenden Laufwerke gibt, wird das neue
		Laufwerk als Ersatz (<foreignphrase>Spare</foreignphrase>)
		verwendet.</para>

		<para>Das Array in diesem Beispiel beginnt sofort damit, die
		Daten auf das neu hinzugefügte Laufwerk zu kopieren. Alle
		vorhandenen Daten auf dem neuen Laufwerk werden
		überschrieben.</para>

		<screen>&prompt.root; <userinput>graid insert raid/r0 ada1</userinput>
		GEOM_RAID: Intel-a29ea104: Disk ada1 state changed from NONE to ACTIVE.
		GEOM_RAID: Intel-a29ea104: Subdisk gm0:1-ada1 state changed from NONE to NEW.
		GEOM_RAID: Intel-a29ea104: Subdisk gm0:1-ada1 state changed from NEW to REBUILD.
		GEOM_RAID: Intel-a29ea104: Subdisk gm0:1-ada1 rebuild start at 0.</screen>
		</sect2>

		<sect2 xml:id="geom-graid-removing">
		<title>Laufwerke aus dem Array entfernen</title>

		<para>Einzelne Laufwerke können permanent aus dem Array entfernt
		werden. Die Metadaten werden dabei gelöscht:</para>

		<screen>&prompt.root; <userinput>graid remove raid/r0 ada1</userinput>
		GEOM_RAID: Intel-a29ea104: Disk ada1 state changed from ACTIVE to OFFLINE.
		GEOM_RAID: Intel-a29ea104: Subdisk gm0:1-[unknown] state changed from ACTIVE to NONE.
		GEOM_RAID: Intel-a29ea104: Volume gm0 state changed from OPTIMAL to DEGRADED.</screen>
		</sect2>

		<sect2 xml:id="geom-graid-stopping">
		<title>Das Array anhalten</title>

		<para>Ein Array kann angehalten werden, ohne dass die Metadaten
		bcrUnsubmitted Not Done Inline Actions das dass muss weg. bcr: das dass muss weg.
		von den Laufwerken zu löschen. Das Array wird wieder
		anlaufen, wenn das System neu gestartet wird.</para>

		<screen>&prompt.root; <userinput>graid stop raid/r0</userinput></screen>
		</sect2>

		<sect2 xml:id="geom-graid-status">
		<title>Den Status des Arrays überprüfen</title>

		<para>Der Status des Arrays kann jederzeit überprüft werden.
		Nachdem ein Laufwerk zum Array hinzugefügt wurde, werden die
		Daten vom ursprünglichen Laufwerk auf das neue Laufwerk
		kopiert:</para>

		<screen>&prompt.root; <userinput>graid status</userinput>
		Name Status Components
		raid/r0 DEGRADED ada0 (ACTIVE (ACTIVE))
		ada1 (ACTIVE (REBUILD 28%))</screen>

		<para>Andere Arten von Arrays, wie <literal>RAID0</literal> oder
		<literal>CONCAT</literal>, werden den Status eines
		fehlgeschlagenen Laufwerks vielleicht nicht anzeigen. Um
		diese teilweise ausgefallenen Arrays anzuzeigen, fügen Sie
		<option>-ga</option> hinzu:</para>

		<screen>&prompt.root; <userinput>graid status -ga</userinput>
		Name Status Components
		Intel-e2d07d9a BROKEN ada6 (ACTIVE (ACTIVE))</screen>
		</sect2>

		<sect2 xml:id="geom-graid-deleting">
		<title>Arrays löschen</title>

		<para>Arrays werden zerstört, indem alle Volumes gelöscht
		werden. Wenn das letzte Volume gelöscht wird, wird das
		Array gestoppt und die Metadaten von den Laufwerken
		entfernt:</para>

		<screen>&prompt.root; <userinput>graid delete raid/r0</userinput></screen>
		</sect2>

		<sect2 xml:id="geom-graid-unexpected">
		<title>Unerwartete Arrays löschen</title>

		<para>Laufwerke können unerwartete &man.graid.8; Metadaten
		enthalten, entweder aus früherer Nutzung oder aus Tests des
		Herstellers. &man.graid.8; würde diese Metadaten erkennen und
		daraus ein Array erstellen, was den Zugriff auf die einzelnen
		Laufwerke beeinträchtigen würde. Um die unerwünschten
		Metadaten zu entfernen:</para>

		<procedure>
		<step>
		<para>Booten Sie das System. Im Boot-Menü wählen Sie
		<literal>2</literal> für den Loader-Prompt. Geben Sie
		dann folgendes ein:</para>

		<screen>OK <userinput>set kern.geom.raid.enable=0</userinput>
		OK <userinput>boot</userinput></screen>

		<para>Das System wird nun mit deaktiviertem &man.graid.8;
		starten.</para>
		</step>

		<step>
		<para>Sichern Sie alle Daten auf dem betroffenen
		Laufwerk.</para>
		</step>

		<step>
		<para>Zur Abhilfe kann auch die Array-Erkennung von
		&man.graid.8; deaktiviert werden, indem</para>

		<programlisting>kern.geom.raid.enable=0</programlisting>

		<para>in <filename>/boot/loader.conf</filename> hinzugefügt
		wird.</para>

		<para>Um die &man.graid.8; Metadaten von dem entsprechenden
		Laufwerk zu entfernen, booten Sie vom &os;
		Installationsmedium und wählen Sie
		<literal>Shell</literal> aus. Benutzen Sie
		<command>status</command>, um den Namen des Arrays zu
		bestimmten, typischerweise
		<literal>raid/r0</literal>:</para>

		<screen>&prompt.root; <userinput>graid status</userinput>
		Name Status Components
		raid/r0 OPTIMAL ada0 (ACTIVE (ACTIVE))
		ada1 (ACTIVE (ACTIVE))</screen>

		<para>Löschen Sie das Volume:</para>

		<screen>&prompt.root; <userinput>graid delete raid/r0</userinput></screen>

		<para>Wiederholen Sie den Vorgang für jedes Volume. Nachdem
		das letzte Volume gelöscht wurde, wird das Volume
		zerstört.</para>

		<para>Starten Sie das System neu und prüfen die
		Vollständigkeit der Daten. Falls erforderlich, müssen die
		Daten aus der Sicherung wiederhergestellt werden. Nachdem
		die Metadaten entfernt wurden, kann auch der Eintrag
		<literal>kern.geom.raid.enable=0</literal> aus
		<filename>/boot/loader.conf</filename> entfernt
		werden.</para>
		</step>
		</procedure>
		</sect2>
		</sect1>

	<sect1 xml:id="geom-raid3">	<sect1 xml:id="geom-raid3">
	<info>	<info>

Context not available.

Document undocumented indent(1) options badp/nbadp, bs/nbs, and lc.ClosedPublicActions