From 952d23a5402e352bf89c22193768e6b9da20a0eb Mon Sep 17 00:00:00 2001 From: Ian Moffett Date: Thu, 24 Apr 2025 21:33:28 -0400 Subject: docs: contrib: Add note about switch/case Signed-off-by: Ian Moffett --- share/misc/contrib | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'share') diff --git a/share/misc/contrib b/share/misc/contrib index a36c127..39c9c02 100644 --- a/share/misc/contrib +++ b/share/misc/contrib @@ -62,6 +62,37 @@ if (!blah) { -- +When writing switch statements, no indentation is needed +before the "case" statement, do this: + +switch (v) { +case 0: + ... + break; +case 1: + ... + break; +case 2: + ... + break; +} + +Not this: + + +switch (v) { +case 0: + ... + break; +case 1: + ... + break; +case 2: + ... + break; +} + +-- Now, only use predefined integer types in sys/cdefs.h like so: uint8_t a; -- cgit v1.2.3 From 24844a174f1340847351870f46ce13ad472ac7e5 Mon Sep 17 00:00:00 2001 From: Ian Moffett Date: Fri, 2 May 2025 21:09:14 -0400 Subject: share: man: Add omar(1) Signed-off-by: Ian Moffett --- share/man/man1/omar.1 | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++ tools/omar/omar.1 | 55 --------------------------------------------------- 2 files changed, 55 insertions(+), 55 deletions(-) create mode 100644 share/man/man1/omar.1 delete mode 100644 tools/omar/omar.1 (limited to 'share') diff --git a/share/man/man1/omar.1 b/share/man/man1/omar.1 new file mode 100644 index 0000000..e59be31 --- /dev/null +++ b/share/man/man1/omar.1 @@ -0,0 +1,55 @@ +.\" Copyright (c) 2025 Ian Marco Moffett and the Osmora Team. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of Hyra nor the names of its +.\" contributors may be used to endorse or promote products derived from +.\" this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.Dd Apr 29 2025 +.Dt OMAR 1 +.Os HYRA +.Sh NAME +.Nm omar - OSMORA Archive Format +.Sh SYNOPSIS +omar -i [input] -o [output] + +.Sh DESCRIPTION +Prepare files for use in an initramfs + +.Ft -i + input path directory + +.Ft -o + output path + +Upon creation of the archive image, OMAR will +produce pathnames through stdout with the following +types in square brackets ([]) + +.Ft f + Regular file + +.Ft d + Directory + +.Sh AUTHORS +.An Ian Moffett Aq Mt ian@osmora.org diff --git a/tools/omar/omar.1 b/tools/omar/omar.1 deleted file mode 100644 index e59be31..0000000 --- a/tools/omar/omar.1 +++ /dev/null @@ -1,55 +0,0 @@ -.\" Copyright (c) 2025 Ian Marco Moffett and the Osmora Team. -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions are met: -.\" -.\" 1. Redistributions of source code must retain the above copyright notice, -.\" this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. Neither the name of Hyra nor the names of its -.\" contributors may be used to endorse or promote products derived from -.\" this software without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -.\" POSSIBILITY OF SUCH DAMAGE. -.Dd Apr 29 2025 -.Dt OMAR 1 -.Os HYRA -.Sh NAME -.Nm omar - OSMORA Archive Format -.Sh SYNOPSIS -omar -i [input] -o [output] - -.Sh DESCRIPTION -Prepare files for use in an initramfs - -.Ft -i - input path directory - -.Ft -o - output path - -Upon creation of the archive image, OMAR will -produce pathnames through stdout with the following -types in square brackets ([]) - -.Ft f - Regular file - -.Ft d - Directory - -.Sh AUTHORS -.An Ian Moffett Aq Mt ian@osmora.org -- cgit v1.2.3 From 2e7a8f3592dc4023256a2e2fcb95f710207d6bdc Mon Sep 17 00:00:00 2001 From: Ian Moffett Date: Fri, 2 May 2025 21:20:33 -0400 Subject: share: man: Add square brackets in omar(1) Make types vs flags more clear Signed-off-by: Ian Moffett --- share/man/man1/omar.1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'share') diff --git a/share/man/man1/omar.1 b/share/man/man1/omar.1 index e59be31..611b6da 100644 --- a/share/man/man1/omar.1 +++ b/share/man/man1/omar.1 @@ -24,7 +24,7 @@ .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. -.Dd Apr 29 2025 +.Dd May 2 2025 .Dt OMAR 1 .Os HYRA .Sh NAME @@ -45,10 +45,10 @@ Upon creation of the archive image, OMAR will produce pathnames through stdout with the following types in square brackets ([]) -.Ft f +.Ft [f] Regular file -.Ft d +.Ft [d] Directory .Sh AUTHORS -- cgit v1.2.3