From f5d11e00622c11c6b075874023ce728fff5a776c Mon Sep 17 00:00:00 2001 From: neil Date: Sun, 22 Jan 2017 01:33:44 +0000 Subject: [PATCH] Cleaned up formatting of AutoDocs (mostly indentation). git-svn-id: https://svn.aros.org/svn/aros/trunk/AROS@53268 fb15a70f-31f2-0310-bbcc-cdcc74a49acc --- rom/partition/addbootfilesystem.c | 26 +++++----- rom/partition/addpartition.c | 35 +++++++------ rom/partition/closepartitiontable.c | 19 +++----- rom/partition/closerootpartition.c | 16 +++--- rom/partition/createpartitiontable.c | 30 ++++++------ rom/partition/deletepartition.c | 17 +++---- rom/partition/destroypartitiontable.c | 21 ++++---- rom/partition/findfilesystema.c | 24 ++++----- rom/partition/getfilesystemattrsa.c | 46 ++++++++--------- rom/partition/getpartitionattrs.c | 84 +++++++++++++++++++------------- rom/partition/getpartitiontableattrs.c | 25 +++++----- rom/partition/loadbootfilesystems.c | 20 ++++---- rom/partition/loadfilesystem.c | 18 +++---- rom/partition/openpartitiontable.c | 24 ++++----- rom/partition/openrootpartition.c | 18 +++---- rom/partition/querypartitionattrs.c | 18 +++---- rom/partition/querypartitiontableattrs.c | 18 +++---- rom/partition/readpartitiondata.c | 13 +++-- rom/partition/setpartitionattrs.c | 18 ++++--- rom/partition/setpartitiontableattrs.c | 16 +++--- rom/partition/writepartitiondata.c | 11 ++--- rom/partition/writepartitiontable.c | 20 +++----- 22 files changed, 260 insertions(+), 277 deletions(-) diff --git a/rom/partition/addbootfilesystem.c b/rom/partition/addbootfilesystem.c index e2df246316..21ae9ef7d8 100644 --- a/rom/partition/addbootfilesystem.c +++ b/rom/partition/addbootfilesystem.c @@ -1,5 +1,5 @@ /* - Copyright © 2011, The AROS Development Team. All rights reserved. + Copyright © 2011-2017, The AROS Development Team. All rights reserved. $Id$ */ @@ -16,29 +16,29 @@ NAME */ #include - AROS_LH1(LONG, AddBootFileSystem, + AROS_LH1(LONG, AddBootFileSystem, /* SYNOPSIS */ - AROS_LHA(struct Node *, handle, A1), + AROS_LHA(struct Node *, handle, A1), /* LOCATION */ - struct Library *, PartitionBase, 23, Partition) + struct Library *, PartitionBase, 23, Partition) /* FUNCTION - Adds the specified filesystem to the system list of bootable filesystems - (actually FileSystem.resource). + Adds the specified filesystem to the system list of bootable + filesystems (actually FileSystem.resource). INPUTS - handle - Filesystem handle obtained by FindFileSystemA() + handle - Filesystem handle obtained by FindFileSystemA() RESULT - Zero if everything went okay or common dos.library-compliant error code. + Zero if everything went okay or common dos.library-compliant error code. NOTES - This function can be called during system startup before dos.library is - available. In this case filesystem loading will be delayed until dos.library - started up. Delayed loading will be handled automatically without any caller's - intervention. + This function can be called during system startup before dos.library + is available. In this case filesystem loading will be delayed until + dos.library started up. Delayed loading will be handled automatically + without any caller's intervention. EXAMPLE @@ -48,8 +48,6 @@ INTERNALS - HISTORY - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/addpartition.c b/rom/partition/addpartition.c index de2b0e8496..3e1f8a8450 100644 --- a/rom/partition/addpartition.c +++ b/rom/partition/addpartition.c @@ -13,34 +13,33 @@ NAME */ #include - AROS_LH2(struct PartitionHandle *, AddPartition, + AROS_LH2(struct PartitionHandle *, AddPartition, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), - AROS_LHA(const struct TagItem * , taglist, A2), + AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(const struct TagItem * , taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 11, Partition) + struct Library *, PartitionBase, 11, Partition) /* FUNCTION - Add a new partition. + Add a new partition. INPUTS - root - PartitionHandle, where to add the new partition - taglist - tags that specify more information about the partition - unknown tags are ignored - PT_DOSENVEC - ptr to a DosEnvec - de_LowCyl and de_HighCyl specify start and end of cylinder - de_Reserved, de_Bootblocks, ... - de_Surfaces, de_BlocksPerTrack, ... are inherited from "root" - PT_TYPE - partition type (depends on PartitionTable type) - PT_POSITION - position number within the partition table (MBR->PC) - PT_ACTIVE - set this partition active (MBR->PC) - PT_NAME - set partition name (HD0, HD1, ...) - + root - PartitionHandle, where to add the new partition + taglist - tags that specify more information about the partition + unknown tags are ignored + PT_DOSENVEC - ptr to a DosEnvec + de_LowCyl and de_HighCyl specify start and end of cylinder + de_Reserved, de_Bootblocks, ... + de_Surfaces, de_BlocksPerTrack, ... are inherited from "root" + PT_TYPE - partition type (depends on PartitionTable type) + PT_POSITION - position number within the partition table (MBR->PC) + PT_ACTIVE - set this partition active (MBR->PC) + PT_NAME - set partition name (HD0, HD1, ...) RESULT - PartitionHandle of the new partition; 0 for an error + PartitionHandle of the new partition; 0 for an error NOTES diff --git a/rom/partition/closepartitiontable.c b/rom/partition/closepartitiontable.c index a4d41c9f4a..38ed2f18c4 100644 --- a/rom/partition/closepartitiontable.c +++ b/rom/partition/closepartitiontable.c @@ -1,7 +1,6 @@ /* - Copyright © 1995-2001, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include @@ -15,20 +14,20 @@ NAME */ #include - AROS_LH1(void, ClosePartitionTable, + AROS_LH1(void, ClosePartitionTable, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(struct PartitionHandle *, root, A1), /* LOCATION */ - struct Library *, PartitionBase, 8, Partition) + struct Library *, PartitionBase, 8, Partition) /* FUNCTION - close a partition table (and discard all changes) - all partitions and subpartitions in root->list will be removed recursivly + Close a partition table (and discard all changes). All partitions + and subpartitions in root->list will be removed recursively. INPUTS - root - partition table to close + root - partition table to close RESULT @@ -42,9 +41,6 @@ INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT @@ -61,4 +57,3 @@ AROS_LIBFUNC_EXIT } - diff --git a/rom/partition/closerootpartition.c b/rom/partition/closerootpartition.c index cce67c9f7a..bdd19a6a85 100644 --- a/rom/partition/closerootpartition.c +++ b/rom/partition/closerootpartition.c @@ -1,7 +1,6 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include @@ -16,19 +15,19 @@ NAME */ #include - AROS_LH1(void, CloseRootPartition, + AROS_LH1(void, CloseRootPartition, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, ph, A1), + AROS_LHA(struct PartitionHandle *, ph, A1), /* LOCATION */ - struct Library *, PartitionBase, 6, Partition) + struct Library *, PartitionBase, 6, Partition) /* FUNCTION - close root handle allocated by OpenRootPartition() + Close a root handle allocated by OpenRootPartition(). INPUTS - ph - root handle created by OpenRootPartition() + ph - root handle created by OpenRootPartition() RESULT @@ -42,9 +41,6 @@ INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/createpartitiontable.c b/rom/partition/createpartitiontable.c index 22752e62a4..97d01f9008 100644 --- a/rom/partition/createpartitiontable.c +++ b/rom/partition/createpartitiontable.c @@ -1,8 +1,8 @@ /* - Copyright © 1995-2001, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ + #include #include #include "partition_support.h" @@ -13,29 +13,30 @@ NAME */ #include - AROS_LH2(LONG, CreatePartitionTable, + AROS_LH2(LONG, CreatePartitionTable, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), - AROS_LHA(ULONG, type, D1), + AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(ULONG, type, D1), /* LOCATION */ - struct Library *, PartitionBase, 10, Partition) + struct Library *, PartitionBase, 10, Partition) /* FUNCTION - Create a new partition table. + Create a new partition table. INPUTS - root - partition to create table in - type - the type of the partition table to create + root - partition to create table in + type - the type of the partition table to create RESULT - 0 on success; an error code otherwise + 0 on success; an error code otherwise NOTES - After calling this function the state of the PartitionHandle will be the - same as when calling OpenPartitionTable(). Therefore before closing the - PartitionHandle you should call ClosePartitionTable(). + After calling this function the state of the PartitionHandle will be + the same as when calling OpenPartitionTable(). Therefore before + closing the PartitionHandle you should call ClosePartitionTable(). + EXAMPLE BUGS @@ -44,9 +45,6 @@ INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/deletepartition.c b/rom/partition/deletepartition.c index 5956799260..3b8e6bc36a 100644 --- a/rom/partition/deletepartition.c +++ b/rom/partition/deletepartition.c @@ -1,8 +1,8 @@ /* - Copyright © 1995-2001, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ + #include "partition_support.h" #include "platform.h" @@ -11,19 +11,19 @@ NAME */ #include - AROS_LH1(void, DeletePartition, + AROS_LH1(void, DeletePartition, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, ph, A1), + AROS_LHA(struct PartitionHandle *, ph, A1), /* LOCATION */ - struct Library *, PartitionBase, 12, Partition) + struct Library *, PartitionBase, 12, Partition) /* FUNCTION - Delete a partition with its subpartitions + Delete a partition along with its subpartitions. INPUTS - ph - PartitionHandle to delete + ph - PartitionHandle to delete RESULT @@ -37,9 +37,6 @@ INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/destroypartitiontable.c b/rom/partition/destroypartitiontable.c index 07fecb072f..3e29efb948 100644 --- a/rom/partition/destroypartitiontable.c +++ b/rom/partition/destroypartitiontable.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2003, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ */ @@ -14,27 +14,28 @@ NAME */ #include - AROS_LH1(LONG, DestroyPartitionTable, + AROS_LH1(LONG, DestroyPartitionTable, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(struct PartitionHandle *, root, A1), /* LOCATION */ - struct Library *, PartitionBase, 19, Partition) + struct Library *, PartitionBase, 19, Partition) /* FUNCTION - Destroy a partition table by immediately overwriting table data on disk. + Destroy a partition table by immediately overwriting table data on + disk. INPUTS - root - partition table to destroy + root - partition table to destroy RESULT - 0 on success; an error code otherwise + 0 on success; an error code otherwise NOTES - After calling this function the state of the PartitionHandle will be the - same as before calling OpenPartitionTable(). Therefore do not reference - any child PartitionHandles any more. + After calling this function the state of the PartitionHandle will be + the same as before calling OpenPartitionTable(). Therefore do not + reference any child PartitionHandles any more. EXAMPLE diff --git a/rom/partition/findfilesystema.c b/rom/partition/findfilesystema.c index 272c167292..eb1e02c2c8 100644 --- a/rom/partition/findfilesystema.c +++ b/rom/partition/findfilesystema.c @@ -1,8 +1,8 @@ /* Copyright © 2011-2017, The AROS Development Team. All rights reserved. $Id$ - */ + #include "partition_support.h" #include "platform.h" @@ -11,32 +11,32 @@ NAME */ #include - AROS_LH2(struct Node *, FindFileSystemA, + AROS_LH2(struct Node *, FindFileSystemA, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, table, A1), - AROS_LHA(const struct TagItem *, taglist, A2), + AROS_LHA(struct PartitionHandle *, table, A1), + AROS_LHA(const struct TagItem *, taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 20, Partition) + struct Library *, PartitionBase, 20, Partition) /* FUNCTION - Locate a filesystem handler in the partition + Locate a filesystem handler in the partition. INPUTS - ph - PartitionHandle to the table - taglist - Taglist specifying arguments. Possible tags are: + ph - PartitionHandle to the table + taglist - Taglist specifying arguments. Possible tags are: FST_ID - specify ID of the filesystem. FST_NAME - specify name of the filesystem. If more than one condition is specified for the search, logical - AND will be applied to them. Empty taglist will give you the first - filesystem in the list. + AND will be applied to them. Empty taglist will give you the + first filesystem in the list. RESULT - Abstract handle of a filesystem or NULL if the filesystem with the given - parameters was not located in the partition. + Abstract handle of a filesystem or NULL if the filesystem with the + given parameters was not located in the partition. NOTES diff --git a/rom/partition/getfilesystemattrsa.c b/rom/partition/getfilesystemattrsa.c index 8cd49b1ace..9bd4c59590 100644 --- a/rom/partition/getfilesystemattrsa.c +++ b/rom/partition/getfilesystemattrsa.c @@ -1,7 +1,6 @@ /* Copyright © 2011-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include @@ -15,39 +14,42 @@ #include #include - AROS_LH2(void, GetFileSystemAttrsA, + AROS_LH2(void, GetFileSystemAttrsA, /* SYNOPSIS */ - AROS_LHA(struct Node *, handle, A1), - AROS_LHA(const struct TagItem *, taglist, A2), + AROS_LHA(struct Node *, handle, A1), + AROS_LHA(const struct TagItem *, taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 22, Partition) + struct Library *, PartitionBase, 22, Partition) /* FUNCTION - get attributes of a partition table + get attributes of a partition table INPUTS - handle - Filesystem handle - taglist - list of attributes; unknown tags are ignored - FST_ID (ULONG *) - Get 4-characters filesystem ID - FST_NAME (STRPTR *) - Get a pointer to filesystem name - FST_FSENTRY (struct FileSysEntry *) - Fill in the given struct FileSysEntry. + handle - Filesystem handle + taglist - list of attributes; unknown tags are ignored + + TAGS + FST_ID (ULONG *) - Get 4-character FS ID + FST_NAME (STRPTR *) - Get a pointer to FS name + FST_FSENTRY (struct FileSysEntry *) - Fill in given FileSysEntry. RESULT None. NOTES - Name is returned as a pointer to internally allocated string. You should copy - it if you want to keep it after filesystem's partition table had been closed. - - The following fields in struct FileSysEntry will not be filled in: - - Node name - - fse_Handler - - fse_SegList - You need to query for filesystem's name separately and copy it into BSTR - yourself, if you need to. Loading the handler is done by LoadFileSystem() - function. + Name is returned as a pointer to an internally allocated string. You + should copy it if you want to keep it after the filesystem's + partition table handle has been closed. + + The following fields in struct FileSysEntry will not be filled in: + - Node name + - fse_Handler + - fse_SegList + You need to query for the filesystem's name separately and copy it + into a BSTR yourself, if you need to. Loading the handler is done by + the LoadFileSystem() function. EXAMPLE @@ -70,7 +72,7 @@ handler->getFileSystemAttr(PartitionBase, (struct FileSysHandle *)handle, tag); /* - * TODO: handler returns TRUE if it knows the attrubute and FALSE otherwise. + * TODO: handler returns TRUE if it knows the attribute and FALSE otherwise. * If we ever have more partition table types which can handle embedded * filesystem handlers, this can be expanded similar to GetPartitionAttrs(), * and we will have some generic code here. diff --git a/rom/partition/getpartitionattrs.c b/rom/partition/getpartitionattrs.c index ad401e4bc1..2133a7ed47 100644 --- a/rom/partition/getpartitionattrs.c +++ b/rom/partition/getpartitionattrs.c @@ -1,7 +1,6 @@ /* Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include @@ -16,58 +15,73 @@ #include #include - AROS_LH2(LONG, GetPartitionAttrs, + AROS_LH2(LONG, GetPartitionAttrs, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, ph, A1), - AROS_LHA(const struct TagItem *, taglist, A2), + AROS_LHA(struct PartitionHandle *, ph, A1), + AROS_LHA(const struct TagItem *, taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 15, Partition) + struct Library *, PartitionBase, 15, Partition) /* FUNCTION - get attributes of a partition + Get attributes of a partition. INPUTS - ph - PartitionHandle - taglist - list of attributes, unknown tags are ignored: - - PT_GEOMETRY - struct DriveGeometry * ; Fill in DriveGeometry structure - PT_DOSENVEC - struct DosEnvec * ; Fill in DosEnvec structure - PT_TYPE - struct PartitionType * ; Get partition type - PT_POSITION - ULONG * ; Get position (entry number) of partition within its table. - ; Returns -1 is there's no table (e. g. if used on disk root) - PT_ACTIVE - LONG * ; Get value of "active" flag (PC-MBR specific) - PT_BOOTABLE - LONG * ; Get value of "bootable" flag - PT_AUTOMOUNT - LONG * ; Get value of "automount" flag - PT_NAME - STRPTR ; Get name of partition (max 31 Bytes + NULL-byte) - PT_STARTBLOCK - UQUAD * ; Get number of starting block for the partition (V2) - PT_ENDBLOCK - UQUAD * ; Get number of ending block for the partition (V2) + ph - PartitionHandle + taglist - list of attributes, unknown tags are ignored + + TAGS + PT_GEOMETRY (struct DriveGeometry *) + Fill in DriveGeometry structure + PT_DOSENVEC (struct DosEnvec *) + Fill in DosEnvec structure + PT_TYPE (struct PartitionType *) + Get partition type + PT_POSITION (ULONG *) + Get position (entry number) of partition within its table. + Returns -1 if there's no table (e.g. if used on disk root) + PT_ACTIVE (LONG *) + Get value of "active" flag (PC-MBR specific) + PT_BOOTABLE (LONG *) + Get value of "bootable" flag + PT_AUTOMOUNT (LONG *) + Get value of "automount" flag + PT_NAME (STRPTR) + Get name of partition (max 31 Bytes + NUL-byte) + PT_STARTBLOCK (UQUAD *) + Get number of starting block for the partition (V2) + PT_ENDBLOCK (UQUAD *) + Get number of ending block for the partition (V2) RESULT - Currently reserved, always zero. + Currently reserved, always zero. NOTES - Nested partition tables (e. g. RDB subpartitions on PC MBR drive) are treated as virtual disks. - In this case start and end block numbers are relative to the beginning of the virtual disk - (which is represented by parent partition containing the RDB itself), not absolute numbers. - The same applies to DriveGeomerty and geometry-related fields in DosEnvec structure. - - Note that geometry data can be stored on disk in the partition table ifself (RDB for example), and - this way it can not match physical device's geometry (for example, if the disk was partitioned on - another operating system which used virtual geometry). In this case you might need to adjust these - data in order to mount the file system correctly (if absolute start/end blocks are not - cylinder-aligned). - - Starting from V2, partition.library always provides default values for all attributes, even for those - not listed as readable in QueryPartitionAttrs() results. + Nested partition tables (e.g. RDB subpartitions on PC MBR drive) are + treated as virtual disks. In this case start and end block numbers are + relative to the beginning of the virtual disk (which is represented by + a parent partition containing the RDB itself), not absolute numbers. + The same applies to DriveGeomerty and geometry-related fields in the + DosEnvec structure. + + Note that geometry data can be stored on disk in the partition table + ifself (RDB for example), and this way it may not match the physical + device's geometry (for example, if the disk was partitioned on + another operating system which used virtual geometry). In this case + you might need to adjust these data in order to mount the file system + correctly (if absolute start/end blocks are not cylinder-aligned). + + Starting from V2, partition.library always provides default values + for all attributes, even for those not listed as readable in + QueryPartitionAttrs() results. EXAMPLE BUGS SEE ALSO - SetPartitionAttrs() + SetPartitionAttrs() INTERNALS diff --git a/rom/partition/getpartitiontableattrs.c b/rom/partition/getpartitiontableattrs.c index 4baf96025d..4060ccef86 100644 --- a/rom/partition/getpartitiontableattrs.c +++ b/rom/partition/getpartitiontableattrs.c @@ -1,7 +1,6 @@ /* Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include @@ -16,24 +15,28 @@ #include #include - AROS_LH2(LONG, GetPartitionTableAttrs, + AROS_LH2(LONG, GetPartitionTableAttrs, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), - AROS_LHA(const struct TagItem *, taglist, A2), + AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(const struct TagItem *, taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 13, Partition) + struct Library *, PartitionBase, 13, Partition) /* FUNCTION - get attributes of a partition table + Get attributes of a partition table. INPUTS - ph - PartitionHandle of the partition table - taglist - list of attributes; unknown tags are ignored - PTT_TYPE - ULONG * ; get partition table type - PTT_MAXLEADIN - LONG * - PTT_RESERVED - ULONG * ; get number of reserved blocks + ph - PartitionHandle of the partition table + taglist - list of attributes; unknown tags are ignored + + TAGS + PTT_TYPE (ULONG *) + Get partition table type + PTT_MAXLEADIN (LONG *) + PTT_RESERVED (ULONG *) + Get number of reserved blocks RESULT diff --git a/rom/partition/loadbootfilesystems.c b/rom/partition/loadbootfilesystems.c index 6d2bbdf5b5..0e6f8c3cd5 100644 --- a/rom/partition/loadbootfilesystems.c +++ b/rom/partition/loadbootfilesystems.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2014, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ */ @@ -15,26 +15,26 @@ /***************************************************************************** NAME */ - AROS_LH0(LONG, LoadBootFileSystems, + AROS_LH0(LONG, LoadBootFileSystems, /* SYNOPSIS */ /* LOCATION */ - struct Library *, PartitionBase, 24, Partition) + struct Library *, PartitionBase, 24, Partition) /* FUNCTION - Perform a deferred loading of boot filesystems. + Perform a deferred loading of boot filesystems. INPUTS - None. + None. RESULT - Zero if everything went okay or DOS error code in case of failure. + Zero if everything went okay or DOS error code in case of failure. NOTES - This function is actually private, it's called by dos.library during - initialization process. There's no sense to call it from within user - software. + This function is actually private; it's called by dos.library during + the initialization process. There's no sense to call it from within + user software. EXAMPLE @@ -44,8 +44,6 @@ INTERNALS - HISTORY - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/loadfilesystem.c b/rom/partition/loadfilesystem.c index a2e82ea42f..162c28600e 100644 --- a/rom/partition/loadfilesystem.c +++ b/rom/partition/loadfilesystem.c @@ -1,8 +1,8 @@ /* - Copyright © 2011, The AROS Development Team. All rights reserved. + Copyright © 2011-2017, The AROS Development Team. All rights reserved. $Id$ - */ + #include "partition_support.h" #include "platform.h" @@ -11,22 +11,22 @@ NAME */ #include - AROS_LH1(BPTR, LoadFileSystem, + AROS_LH1(BPTR, LoadFileSystem, /* SYNOPSIS */ - AROS_LHA(struct Node *, handle, A1), + AROS_LHA(struct Node *, handle, A1), /* LOCATION */ - struct Library *, PartitionBase, 21, Partition) + struct Library *, PartitionBase, 21, Partition) /* FUNCTION - Load the specified filesystem as DOS segment list. + Load the specified filesystem as a DOS segment list. INPUTS - handle - Filesystem handle obtained by FindFileSystemA() + handle - Filesystem handle obtained by FindFileSystemA() RESULT - DOS seglist or NULL in case of failure. + DOS seglist or NULL in case of failure. NOTES @@ -38,8 +38,6 @@ INTERNALS - HISTORY - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/openpartitiontable.c b/rom/partition/openpartitiontable.c index 68039dd6c0..faf43169c1 100644 --- a/rom/partition/openpartitiontable.c +++ b/rom/partition/openpartitiontable.c @@ -1,7 +1,6 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include @@ -16,25 +15,25 @@ NAME */ #include - AROS_LH1(LONG, OpenPartitionTable, + AROS_LH1(LONG, OpenPartitionTable, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(struct PartitionHandle *, root, A1), /* LOCATION */ - struct Library *, PartitionBase, 7, Partition) + struct Library *, PartitionBase, 7, Partition) /* FUNCTION - Open a partition table. On success root->list will be filled with a - list of PartitionHandles. If one partition contains more - subpartitions, the caller should call OpenPartitionTable() on the - PartitionHandle recursively. + Open a partition table. On success root->list will be filled with a + list of PartitionHandles. If one partition contains more + subpartitions, the caller should call OpenPartitionTable() on the + PartitionHandle recursively. INPUTS - root - root partition + root - root partition RESULT - 0 for success; an error code otherwise. + 0 for success; an error code otherwise. NOTES @@ -46,9 +45,6 @@ INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/openrootpartition.c b/rom/partition/openrootpartition.c index d3a5990be2..2c16990674 100644 --- a/rom/partition/openrootpartition.c +++ b/rom/partition/openrootpartition.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2013, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ */ @@ -14,24 +14,24 @@ /***************************************************************************** NAME */ - AROS_LH2(struct PartitionHandle *, OpenRootPartition, + AROS_LH2(struct PartitionHandle *, OpenRootPartition, /* SYNOPSIS */ - AROS_LHA(CONST_STRPTR, Device, A1), - AROS_LHA(LONG, Unit, D1), + AROS_LHA(CONST_STRPTR, Device, A1), + AROS_LHA(LONG, Unit, D1), /* LOCATION */ - struct Library *, PartitionBase, 5, Partition) + struct Library *, PartitionBase, 5, Partition) /* FUNCTION - Create a root handle by opening a trackdisk-compatible device. + Create a root handle by opening a trackdisk-compatible device. INPUTS - Device - name of the block device - Unit - unit of the block device + Device - name of the block device + Unit - unit of the block device RESULT - handle to the device + Handle to the device NOTES diff --git a/rom/partition/querypartitionattrs.c b/rom/partition/querypartitionattrs.c index 6f91bdceb4..c5d9986545 100644 --- a/rom/partition/querypartitionattrs.c +++ b/rom/partition/querypartitionattrs.c @@ -1,7 +1,6 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include "partition_support.h" @@ -23,22 +22,22 @@ static const struct PartitionAttribute defaultPartitionAttrs[] = NAME */ #include - AROS_LH1(const struct PartitionAttribute *, QueryPartitionAttrs, + AROS_LH1(const struct PartitionAttribute *, QueryPartitionAttrs, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, table, A1), + AROS_LHA(struct PartitionHandle *, table, A1), /* LOCATION */ - struct Library *, PartitionBase, 18, Partition) + struct Library *, PartitionBase, 18, Partition) /* FUNCTION - query partition attributes + Query partition attributes. INPUTS - ph - PartitionHandle to the table + ph - PartitionHandle to the table RESULT - list of NULL-terminated ULONGs with attributes + List of NULL-terminated ULONGs with attributes. NOTES @@ -50,9 +49,6 @@ static const struct PartitionAttribute defaultPartitionAttrs[] = INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/querypartitiontableattrs.c b/rom/partition/querypartitiontableattrs.c index cf6a9b64de..a2d3baef17 100644 --- a/rom/partition/querypartitiontableattrs.c +++ b/rom/partition/querypartitiontableattrs.c @@ -1,7 +1,6 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include "partition_support.h" @@ -18,22 +17,22 @@ static const struct PartitionAttribute defaultPartitionTableAttrs[] = NAME */ #include - AROS_LH1(const struct PartitionAttribute *, QueryPartitionTableAttrs, + AROS_LH1(const struct PartitionAttribute *, QueryPartitionTableAttrs, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, table, A1), + AROS_LHA(struct PartitionHandle *, table, A1), /* LOCATION */ - struct Library *, PartitionBase, 17, Partition) + struct Library *, PartitionBase, 17, Partition) /* FUNCTION - query partition table attributes + Query partition table attributes. INPUTS - ph - PartitionHandle of a partition table + ph - PartitionHandle of a partition table RESULT - list of NULL-terminated ULONGs with attributes + List of NULL-terminated ULONGs with attributes. NOTES @@ -45,9 +44,6 @@ static const struct PartitionAttribute defaultPartitionTableAttrs[] = INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/readpartitiondata.c b/rom/partition/readpartitiondata.c index 2ffc27b8cf..8e1237112f 100644 --- a/rom/partition/readpartitiondata.c +++ b/rom/partition/readpartitiondata.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2014, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ */ @@ -29,12 +29,13 @@ INPUTS Partition - a handle to a partition to read from Buffer - a pointer to a data buffer - DataSize - Size of data to read in bytes. This size must be a multiple of block size, - in order to ensure correct operation - StartBlock - Number of the first block to start reading from. + DataSize - Size of data to read in bytes. This size must be a + multiple of block size in order to ensure correct + operation + StartBlock - Number of the first block to start reading from RESULT - A return code of DoIO() function which was used to read the data + Return code of DoIO() function which was used to read the data. NOTES @@ -46,8 +47,6 @@ INTERNALS - HISTORY - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/setpartitionattrs.c b/rom/partition/setpartitionattrs.c index 7a6186af91..30e134d20d 100644 --- a/rom/partition/setpartitionattrs.c +++ b/rom/partition/setpartitionattrs.c @@ -1,8 +1,8 @@ /* Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ + #include "partition_support.h" #include "platform.h" @@ -12,21 +12,23 @@ #include #include - AROS_LH2(LONG, SetPartitionAttrs, + AROS_LH2(LONG, SetPartitionAttrs, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, ph, A1), - AROS_LHA(const struct TagItem *, taglist, A2), + AROS_LHA(struct PartitionHandle *, ph, A1), + AROS_LHA(const struct TagItem *, taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 16, Partition) + struct Library *, PartitionBase, 16, Partition) /* FUNCTION - set attributes of a partition + Set attributes of a partition INPUTS - ph - PartitionHandle - taglist - list of attributes; unknown tags are ignored + ph - PartitionHandle + taglist - list of attributes; unknown tags are ignored + + TAGS PT_DOSENVEC - set new DosEnvec values PT_TYPE - change partition type (MBR-PC) PT_POSITION - move partition to another position (MBR-PC) diff --git a/rom/partition/setpartitiontableattrs.c b/rom/partition/setpartitiontableattrs.c index 4a8aa24349..70757dbb70 100644 --- a/rom/partition/setpartitiontableattrs.c +++ b/rom/partition/setpartitiontableattrs.c @@ -1,8 +1,8 @@ /* Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ + #include "partition_support.h" #include "platform.h" @@ -17,21 +17,21 @@ #include #include - AROS_LH2(LONG, SetPartitionTableAttrs, + AROS_LH2(LONG, SetPartitionTableAttrs, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), - AROS_LHA(const struct TagItem *, taglist, A2), + AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(const struct TagItem *, taglist, A2), /* LOCATION */ - struct Library *, PartitionBase, 14, Partition) + struct Library *, PartitionBase, 14, Partition) /* FUNCTION - set attributes of a partition table + Set attributes of a partition table. INPUTS - ph - PartitionHandle of the partition table - taglist - list of attributes; unknown tags are ignored + ph - PartitionHandle of the partition table + taglist - list of attributes; unknown tags are ignored RESULT diff --git a/rom/partition/writepartitiondata.c b/rom/partition/writepartitiondata.c index 71a2b347c5..774ea524c2 100644 --- a/rom/partition/writepartitiondata.c +++ b/rom/partition/writepartitiondata.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2014, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ */ @@ -29,12 +29,13 @@ INPUTS Partition - a handle to a partition to read from Buffer - a pointer to a data buffer - DataSize - Size of data to read in bytes. This size must be a multiple of block size, - in order to ensure correct operation. + DataSize - Size of data to read in bytes. This size must be a + multiple of block size in order to ensure correct + operation. StartBlock - Number of the first block to start writing from. RESULT - A return code of DoIO() function which was used to write the data + Return code of DoIO() function which was used to write the data. NOTES @@ -46,8 +47,6 @@ INTERNALS - HISTORY - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/rom/partition/writepartitiontable.c b/rom/partition/writepartitiontable.c index 98aa64d5b2..02d9b22d58 100644 --- a/rom/partition/writepartitiontable.c +++ b/rom/partition/writepartitiontable.c @@ -1,7 +1,6 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2017, The AROS Development Team. All rights reserved. $Id$ - */ #include "partition_intern.h" @@ -13,23 +12,23 @@ NAME */ #include - AROS_LH1(LONG, WritePartitionTable, + AROS_LH1(LONG, WritePartitionTable, /* SYNOPSIS */ - AROS_LHA(struct PartitionHandle *, root, A1), + AROS_LHA(struct PartitionHandle *, root, A1), /* LOCATION */ - struct Library *, PartitionBase, 9, Partition) + struct Library *, PartitionBase, 9, Partition) /* FUNCTION - Write a partition table; writing this partition table doesn't affect - subpartition tables + Write a partition table; writing this partition table doesn't affect + subpartition tables. INPUTS - root - partition table to write + root - partition table to write RESULT - 0 for success; an error code otherwise + 0 for success; an error code otherwise NOTES @@ -41,9 +40,6 @@ INTERNALS - HISTORY - 21-02-02 first version - *****************************************************************************/ { AROS_LIBFUNC_INIT -- 2.11.4.GIT