Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 36 additions & 37 deletions reference/eio/constants.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</term>
<listitem>
<simpara>
Request minimal priority
Request minimal priority.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -25,7 +25,7 @@
</term>
<listitem>
<simpara>
Request default priority
Request default priority.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -36,7 +36,7 @@
</term>
<listitem>
<simpara>
Request maximal priority
Request maximal priority.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -53,7 +53,7 @@
</term>
<listitem>
<simpara>
The offset is set to specified number of bytes(<parameter>offset</parameter>).
The offset is set to specified number of bytes (<parameter>offset</parameter>).
</simpara>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -94,16 +94,16 @@
</term>
<listitem>
<simpara>
<function>eio_readdir</function> flag. If specified, the result argument of the callback
becomes an array with the following keys:
<literal>'names'</literal> - array of directory names
<literal>'dents'</literal> - array of <literal>struct eio_dirent</literal>-like
arrays having the following keys each:
<literal>'name'</literal> - the directory name;
<literal>'type'</literal> - one of <emphasis>EIO_DT_*</emphasis>
constants;
<literal>'inode'</literal> - the inode number, if available, otherwise
unspecified;
<function>eio_readdir</function> flag. If specified, the result argument of the callback
becomes an array with the following keys:
<literal>'names'</literal> - array of directory names
<literal>'dents'</literal> - array of <literal>struct eio_dirent</literal>-like
arrays having the following keys each:
<literal>'name'</literal> - the directory name;
<literal>'type'</literal> - one of <emphasis>EIO_DT_*</emphasis>
constants;
<literal>'inode'</literal> - the inode number, if available, otherwise
Comment on lines +99 to +105
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this should be a list?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe just refer to eio_readdir() here; on that page there is the same information (which likely should be formatted in a more readable way; a (nested) list might be a good idea).

unspecified.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -114,8 +114,8 @@
</term>
<listitem>
<simpara>
When this flag is specified, the names will be returned in an order
where likely directories come first, in optimal stat order.
When this flag is specified, the names will be returned in an order
where likely directories come first, in optimal stat order.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -126,11 +126,11 @@
</term>
<listitem>
<simpara>
When this flag is specified, then the names will be returned in an order
suitable for <literal>stat</literal>'ing each one. When planning to
<function>stat</function> all files in the given directory, the
returned order will likely be
fastest.
When this flag is specified, then the names will be returned in an order
suitable for <literal>stat</literal>'ing each one. When planning to
<function>stat</function> all files in the given directory, the
returned order will likely be
fastest.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -141,7 +141,6 @@
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
Expand All @@ -155,7 +154,7 @@
</term>
<listitem>
<simpara>
Unknown node type(very common). Further <function>stat</function> needed.
Unknown node type (very common). Further <function>stat</function> needed.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -166,7 +165,7 @@
</term>
<listitem>
<simpara>
FIFO node type
FIFO node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -177,7 +176,7 @@
</term>
<listitem>
<simpara>
Node type
Node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -188,7 +187,7 @@
</term>
<listitem>
<simpara>
Multiplexed char device (v7+coherent) node type
Multiplexed char device (v7+coherent) node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -199,7 +198,7 @@
</term>
<listitem>
<simpara>
Directory node type
Directory node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -210,7 +209,7 @@
</term>
<listitem>
<simpara>
Xenix special named file node type
Xenix special named file node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -221,7 +220,7 @@
</term>
<listitem>
<simpara>
Node type
Node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -232,7 +231,7 @@
</term>
<listitem>
<simpara>
Multiplexed block device (v7+coherent)
Multiplexed block device (v7+coherent).
</simpara>
</listitem>
</varlistentry>
Expand All @@ -243,7 +242,7 @@
</term>
<listitem>
<simpara>
Node type
Node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -264,7 +263,7 @@
</term>
<listitem>
<simpara>
HP-UX network special node type
HP-UX network special node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -275,7 +274,7 @@
</term>
<listitem>
<simpara>
Link node type
Link node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -286,7 +285,7 @@
</term>
<listitem>
<simpara>
Socket node type
Socket node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -297,7 +296,7 @@
</term>
<listitem>
<simpara>
Solaris door node type
Solaris door node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -308,7 +307,7 @@
</term>
<listitem>
<simpara>
Node type
Node type.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -319,7 +318,7 @@
</term>
<listitem>
<simpara>
Highest node type value
Highest node type value.
</simpara>
</listitem>
</varlistentry>
Expand Down