[haiku-commits] haiku: hrev45260 - docs/user/storage

  • From: jscipione@xxxxxxxxx
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Sat, 9 Feb 2013 04:43:58 +0100 (CET)

hrev45260 adds 2 changesets to branch 'master'
old head: 53671617778a3bae32e552453ee53083420c9bc7
new head: b3252dc18a923eeb3bb3ee738c41904cc0260a4e
overview: http://cgit.haiku-os.org/haiku/log/?qt=range&q=b3252dc+%5E5367161

----------------------------------------------------------------------------

185c12a: Whoops, NodeInfo.h not Node.h

b3252dc: NodeMonitor doc updates

                                     [ John Scipione <jscipione@xxxxxxxxx> ]

----------------------------------------------------------------------------

2 files changed, 41 insertions(+), 27 deletions(-)
docs/user/storage/NodeInfo.dox    |  2 +-
docs/user/storage/NodeMonitor.dox | 66 +++++++++++++++++++++--------------

############################################################################

Commit:      185c12a1b784a0dbe3dffd859010e21316e3e579
URL:         http://cgit.haiku-os.org/haiku/commit/?id=185c12a
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Sat Feb  9 03:42:54 2013 UTC

Whoops, NodeInfo.h not Node.h

----------------------------------------------------------------------------

diff --git a/docs/user/storage/NodeInfo.dox b/docs/user/storage/NodeInfo.dox
index 9534884..121ceff 100644
--- a/docs/user/storage/NodeInfo.dox
+++ b/docs/user/storage/NodeInfo.dox
@@ -14,7 +14,7 @@
 
 
 /*!
-       \file Node.h
+       \file NodeInfo.h
        \ingroup storage
        \ingroup libbe
        \brief Provides the BNodeInfo class.

############################################################################

Revision:    hrev45260
Commit:      b3252dc18a923eeb3bb3ee738c41904cc0260a4e
URL:         http://cgit.haiku-os.org/haiku/commit/?id=b3252dc
Author:      John Scipione <jscipione@xxxxxxxxx>
Date:        Sat Feb  9 03:43:36 2013 UTC

NodeMonitor doc updates

----------------------------------------------------------------------------

diff --git a/docs/user/storage/NodeMonitor.dox 
b/docs/user/storage/NodeMonitor.dox
index ecda789..7cc288c 100644
--- a/docs/user/storage/NodeMonitor.dox
+++ b/docs/user/storage/NodeMonitor.dox
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Haiku Inc. All rights reserved.
+ * Copyright 2003-2013 Haiku Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  *
  * Authors:
@@ -92,132 +92,145 @@
 
        \internal Implementation detail. Not in Be Book.
 
-       Flag for watch_node(). Subscribe to watching when a file is written to.
+       To avoid a flood of messages for small and frequent write operations on 
an
+       open file the file system can limit the number of notifications and mark
+       them with the \c B_WATCH_INTERIM_STAT flag.
 */
 
 
 /*!
        \def B_ENTRY_CREATED
 
-       \c B_NODE_MONITOR notification message "opcode", entry created.
+       \c B_NODE_MONITOR notification message "opcode" is set when entry is
+       created.
 */
 
 
 /*!
        \def B_ENTRY_REMOVED
 
-       \c B_NODE_MONITOR notification message "opcode", entry removed.
+       \c B_NODE_MONITOR notification message "opcode" is set when entry is
+       removed.
 */
 
 
 /*!
        \def B_ENTRY_MOVED
 
-       \c B_NODE_MONITOR notification message "opcode", entry moved.
+       \c B_NODE_MONITOR notification message "opcode" is set when entry is
+       moved.
 */
 
 
 /*!
        \def B_STAT_CHANGED
 
-       \c B_NODE_MONITOR notification message "opcode", stat changed.
+       \c B_NODE_MONITOR notification message "opcode" set when stat info
+       changes. More information can be found in the "fields" field.
 */
 
 
 /*!
        \def B_ATTR_CHANGED
 
-       \c B_NODE_MONITOR notification message "opcode", attribute changed.
+       \c B_NODE_MONITOR notification message "opcode" set when attribute
+       changes. More information can be found in the "cause" field.
 */
 
 
 /*!
        \def B_DEVICE_MOUNTED
 
-       \c B_NODE_MONITOR notification message "opcode", device mounted.
+       \c B_NODE_MONITOR notification message "opcode" set when device is
+       mounted.
 */
 
 
 /*!
        \def B_DEVICE_UNMOUNTED
 
-       \c B_NODE_MONITOR notification message "opcode", device unmounted.
+       \c B_NODE_MONITOR notification message "opcode" set when device is
+       unmounted.
 */
 
 
 /*!
        \def B_ATTR_CREATED
 
-       \c B_ATTR_CHANGED notification message "cause", attribute created.
-       (Haiku only)
+       \c B_ATTR_CHANGED notification message "cause" set when attribute is
+       created. (Haiku only)
 */
 
 
 /*!
        \def B_ATTR_REMOVED
 
-       \c B_ATTR_CHANGED notification message "cause", attribute removed.
-       (Haiku only)
+       \c B_ATTR_CHANGED notification message "cause" set when attribute is
+       removed. (Haiku only)
 */
 
 
 /*!
        \var B_STAT_MODE
 
-       \c B_STAT_CHANGED notification messages "fields" flag, mode changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when stat mode
+       changes.
 */
 
 
 /*!
        \var B_STAT_UID
 
-       \c B_STAT_CHANGED notification messages "fields" flag, UID changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when UID
+       changes.
 */
 
 
 /*!
        \var B_STAT_GID
 
-       \c B_STAT_CHANGED notification messages "fields" flag, GID changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when GID
+       changes.
 */
 
 
 /*!
        \var B_STAT_SIZE
 
-       \c B_STAT_CHANGED notification messages "fields" flag, stat size 
changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when stat size
+       changes.
 */
 
 
 /*!
        \var B_STAT_ACCESS_TIME
 
-       \c B_STAT_CHANGED notification messages "fields" flag, access time
-       changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when access 
time
+       changes.
 */
 
 
 /*!
        \var B_STAT_MODIFICATION_TIME
 
-       \c B_STAT_CHANGED notification messages "fields" flag, modification time
-       changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when
+       modification time changes.
 */
 
 
 /*!
        \var B_STAT_CREATION_TIME
 
-       \c B_STAT_CHANGED notification messages "fields" flag, creation time
-       changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when creation
+       time changes.
 */
 
 
 /*!
        \var B_STAT_CHANGE_TIME
 
-       \c B_STAT_CHANGED notification messages "fields" flag, time information
-       changed.
+       \c B_STAT_CHANGED notification messages "fields" flag set when access,
+       modification or creation time changes.
 */
 
 
@@ -226,7 +239,8 @@
 
        \internal Implementation detail. Not in Be Book.
 
-       \c B_STAT_CHANGED notification messages "fields" flag, file is written 
to.
+       \c B_STAT_CHANGED notification messages "fields" flag set when file is
+       written to.
 */
 
 


Other related posts:

  • » [haiku-commits] haiku: hrev45260 - docs/user/storage - jscipione