From 131945b14b0bb1ef0c179773d32465031ff4f126 Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Wed, 11 Dec 2013 22:08:24 +0100 Subject: [PATCH] Doc fixes about ignore files. --- doc/architecture.rst | 23 ++++++++++++++++--- doc/visualtour.rst | 54 +++++++++++++++++++------------------------- 2 files changed, 43 insertions(+), 34 deletions(-) diff --git a/doc/architecture.rst b/doc/architecture.rst index 54e80fd16..7098a0855 100644 --- a/doc/architecture.rst +++ b/doc/architecture.rst @@ -159,9 +159,26 @@ If a pattern is ending with character `/` it means that only directories are matched. The pattern is only applied for directory components of the checked filename. -The file pattern match is done with the unix function fnmatch which implements -shell wildcard patterns. Note that this is not full regular expression support -but similar to what can be done on the command line to match files. +To match file names against the exclude patterns, the unix standard C +library function fnmatch is used. It checks the filename against the pattern +using standard shell wildcard pattern matching. Check `The opengroup website +` +for the gory details. + +The path that is checked is the relative path unter the sync root directory. + +Examples: +^^^^^^^^^ ++-----------+------------------------------+ +| Pattern | Matches | ++===========+==============================+ +| ``~$*`` | ``~$foo``, ``~$example.doc`` | ++-----------+------------------------------+ +| ``fl?p`` | ``flip``, ``flap`` | ++-----------+------------------------------+ +| ``moo/`` | ``map/moo/``, ``moo/`` | ++-----------+------------------------------+ + The Sync Journal ---------------- diff --git a/doc/visualtour.rst b/doc/visualtour.rst index 9a55cdb62..5582f45c3 100644 --- a/doc/visualtour.rst +++ b/doc/visualtour.rst @@ -144,19 +144,26 @@ The Ignored Files Editor .. index:: ignored files, exclude files, pattern -The ignored files editor allows adding patterns for files or directories -that should be excluded from the sync process. Next to normal characters, +ownCloud Client has the ability to exclude files from the sync process. +The ignored files editor allows editing of custom patterns for files or +directories that should be excluded from the sync process. + +There is a system wide list of default ignore patterns. These global defaults +cannot be directly modified within the editor. Hovering with the mouse will +reveal the location of the global exclude definition file. + +.. image:: images/ignored_files_editor.png + :scale: 50% + +Each line contains an ignore pattern string. Next to normal characters, wildcards can be used to match an arbitrary number of characters, designated by an asterisk (``*``) or a single character, designated by a question mark -(``?``). +(``?``). If a pattern ends with a slash character (``/``) the pattern is only +applied to directory components of the path to check. -Global defaults cannot be directly modified within the editor. Hovering -with the mouse will reveal the location of the global exclude definition -file. - -In addition to this list, ownCloud Client always excludes files with -characters that cannot be synched down to other file systems, -see :ref:`ignored-files-label`. +If the checkbox is checked for a pattern in the editor it means that files +which are matched by this pattern are fleeting metadata which the client will +*remove*. .. note:: Modifying the global exclude definition file might render the client unusable or cause undesired behavior. @@ -164,26 +171,11 @@ see :ref:`ignored-files-label`. .. note:: Custom entries are currently not validated for syntactical correctness by the editor, but might fail to load correctly. -.. image:: images/ignored_files_editor.png - :scale: 50% +In addition to this list, ownCloud Client always excludes files with +characters that cannot be synced to other file systems. -Pattern Matching -^^^^^^^^^^^^^^^^ +With version 1.5.0 it also ignores files that caused individual errors +while syncing for a three times. These are listed in the activity view. +There also is a button to retry the sync for another three times. -To match file names against the exclude patterns, the unix standard C -library function fnmatch is used. It checks the filename against the pattern -using standard shell wildcard pattern matching. Check `The opengroup website -` -for the gory details. - -The path that is checked is the relative path unter the sync root directory. - -Examples: -^^^^^^^^^ -+-----------+------------------------------+ -| Pattern | Matches | -+===========+==============================+ -| ``~$*`` | ``~$foo``, ``~$example.doc`` | -+-----------+------------------------------+ -| ``fl?p`` | ``flip``, ``flap`` | -+-----------+------------------------------+ +For more detailed information see :ref:`ignored-files-label`.