Skip to content

Tidy up SVN docs #939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kamil-tekiela merged 8 commits into from
Oct 15, 2021
Merged

Tidy up SVN docs #939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c2801d8
Fix svn_fs_delete
kamil-tekiela Sep 10, 2021
66a8196
Fix svn_fs_copy
kamil-tekiela Sep 10, 2021
695d964
Fix svn_fs_abort_txn
kamil-tekiela Sep 10, 2021
8b62138
Fix svn_fs_is_dir
kamil-tekiela Sep 10, 2021
ac7a86c
Fix svn_fs_is_file
kamil-tekiela Sep 10, 2021
cf420d7
Fix svn_fs_make_dir
kamil-tekiela Sep 10, 2021
1060786
Fix svn_fs_make_file
kamil-tekiela Sep 10, 2021
ef06633
Uncomment XML for params
kamil-tekiela Sep 10, 2021
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
15 changes: 7 additions & 8 deletions reference/svn/functions/svn-fs-abort-txn.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-abort-txn" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_abort_txn</refname>
<refpurpose>Abort a transaction, returns true if everything is okay, false otherwise</refpurpose>
<refpurpose>Aborts a transaction</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -14,10 +14,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Abort a transaction, returns true if everything is okay, false otherwise
Aborts a transaction.
</para>
</refsect1>
<!--

<refsect1 role="parameters">
&reftitle.parameters;
<para>
Expand All @@ -26,22 +26,21 @@
<term><parameter>txn</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
</variablelist>
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->

<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
Expand Down
21 changes: 10 additions & 11 deletions reference/svn/functions/svn-fs-copy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-copy" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_copy</refname>
<refpurpose>Copies a file or a directory, returns true if all is ok, false otherwise</refpurpose>
<refpurpose>Copies a file or a directory</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -17,10 +17,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Copies a file or a directory, returns true if all is ok, false otherwise
Copies a file or a directory.
</para>
</refsect1>
<!--

<refsect1 role="parameters">
&reftitle.parameters;
<para>
Expand All @@ -29,46 +29,45 @@
<term><parameter>from_root</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>from_path</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to_root</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to_path</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
</variablelist>
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->

<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
Expand Down
17 changes: 8 additions & 9 deletions reference/svn/functions/svn-fs-delete.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-delete" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_delete</refname>
<refpurpose>Deletes a file or a directory, return true if all is ok, false otherwise</refpurpose>
<refpurpose>Deletes a file or a directory</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Deletes a file or a directory, return true if all is ok, false otherwise
Deletes a file or a directory.
</para>
</refsect1>
<!--

<refsect1 role="parameters">
&reftitle.parameters;
<para>
Expand All @@ -27,30 +27,29 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
</variablelist>
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->

<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
Expand Down
17 changes: 8 additions & 9 deletions reference/svn/functions/svn-fs-is-dir.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-is-dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_is_dir</refname>
<refpurpose>Return true if the path points to a directory, false otherwise</refpurpose>
<refpurpose>Determines if a path points to a directory</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Return true if the path points to a directory, false otherwise
Determines if the given path points to a directory.
</para>
</refsect1>
<!--

<refsect1 role="parameters">
&reftitle.parameters;
<para>
Expand All @@ -27,30 +27,29 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
</variablelist>
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Returns &true; if the path points to a directory, &false; otherwise.
</para>
</refsect1>
-->

<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
Expand Down
17 changes: 8 additions & 9 deletions reference/svn/functions/svn-fs-is-file.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-is-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_is_file</refname>
<refpurpose>Return true if the path points to a file, false otherwise</refpurpose>
<refpurpose>Determines if a path points to a file</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Return true if the path points to a file, false otherwise
Determines if the given path points to a file.
</para>
</refsect1>
<!--

<refsect1 role="parameters">
&reftitle.parameters;
<para>
Expand All @@ -27,30 +27,29 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
</variablelist>
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Returns &true; if the path points to a file, &false; otherwise.
</para>
</refsect1>
-->

<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
Expand Down
17 changes: 8 additions & 9 deletions reference/svn/functions/svn-fs-make-dir.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-make-dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_make_dir</refname>
<refpurpose>Creates a new empty directory, returns true if all is ok, false otherwise</refpurpose>
<refpurpose>Creates a new empty directory</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Creates a new empty directory, returns true if all is ok, false otherwise
Creates a new empty directory.
</para>
</refsect1>
<!--

<refsect1 role="parameters">
&reftitle.parameters;
<para>
Expand All @@ -27,30 +27,29 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description

</para>
</listitem>
</varlistentry>
</variablelist>
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->

<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
Expand Down
Loading