Documentation/fs/: split txt and source files
Randy Dunlap [Wed, 10 Mar 2010 23:21:57 +0000 (15:21 -0800)]
Make dnotify_test.c source file and add it to Makefile so that
bitrot can be prevented.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Documentation/Makefile
Documentation/filesystems/00-INDEX
Documentation/filesystems/Makefile [new file with mode: 0644]
Documentation/filesystems/dnotify.txt
Documentation/filesystems/dnotify_test.c [new file with mode: 0644]

index bde1ca1..6fc7ea1 100644 (file)
@@ -1,3 +1,3 @@
 obj-m := DocBook/ accounting/ auxdisplay/ connector/ \
-       filesystems/configfs/ ia64/ laptops/ networking/ \
+       filesystems/ filesystems/configfs/ ia64/ laptops/ networking/ \
        pcmcia/ spi/ timers/ video4linux/ vm/ watchdog/src/
index 5139b8c..3bae418 100644 (file)
@@ -32,6 +32,8 @@ dlmfs.txt
        - info on the userspace interface to the OCFS2 DLM.
 dnotify.txt
        - info about directory notification in Linux.
+dnotify_test.c
+       - example program for dnotify
 ecryptfs.txt
        - docs on eCryptfs: stacked cryptographic filesystem for Linux.
 exofs.txt
diff --git a/Documentation/filesystems/Makefile b/Documentation/filesystems/Makefile
new file mode 100644 (file)
index 0000000..a5dd114
--- /dev/null
@@ -0,0 +1,8 @@
+# kbuild trick to avoid linker error. Can be omitted if a module is built.
+obj- := dummy.o
+
+# List of programs to build
+hostprogs-y := dnotify_test
+
+# Tell kbuild to always build the programs
+always := $(hostprogs-y)
index 9f5d338..6baf88f 100644 (file)
@@ -62,38 +62,9 @@ disabled, fcntl(fd, F_NOTIFY, ...) will return -EINVAL.
 
 Example
 -------
+See Documentation/filesystems/dnotify_test.c for an example.
 
-       #define _GNU_SOURCE     /* needed to get the defines */
-       #include <fcntl.h>      /* in glibc 2.2 this has the needed
-                                          values defined */
-       #include <signal.h>
-       #include <stdio.h>
-       #include <unistd.h>
-
-       static volatile int event_fd;
-
-       static void handler(int sig, siginfo_t *si, void *data)
-       {
-               event_fd = si->si_fd;
-       }
-
-       int main(void)
-       {
-               struct sigaction act;
-               int fd;
-
-               act.sa_sigaction = handler;
-               sigemptyset(&act.sa_mask);
-               act.sa_flags = SA_SIGINFO;
-               sigaction(SIGRTMIN + 1, &act, NULL);
-
-               fd = open(".", O_RDONLY);
-               fcntl(fd, F_SETSIG, SIGRTMIN + 1);
-               fcntl(fd, F_NOTIFY, DN_MODIFY|DN_CREATE|DN_MULTISHOT);
-               /* we will now be notified if any of the files
-                  in "." is modified or new files are created */
-               while (1) {
-                       pause();
-                       printf("Got event on fd=%d\n", event_fd);
-               }
-       }
+NOTE
+----
+Beginning with Linux 2.6.13, dnotify has been replaced by inotify.
+See Documentation/filesystems/inotify.txt for more information on it.
diff --git a/Documentation/filesystems/dnotify_test.c b/Documentation/filesystems/dnotify_test.c
new file mode 100644 (file)
index 0000000..8b37b4a
--- /dev/null
@@ -0,0 +1,34 @@
+#define _GNU_SOURCE    /* needed to get the defines */
+#include <fcntl.h>     /* in glibc 2.2 this has the needed
+                                  values defined */
+#include <signal.h>
+#include <stdio.h>
+#include <unistd.h>
+
+static volatile int event_fd;
+
+static void handler(int sig, siginfo_t *si, void *data)
+{
+       event_fd = si->si_fd;
+}
+
+int main(void)
+{
+       struct sigaction act;
+       int fd;
+
+       act.sa_sigaction = handler;
+       sigemptyset(&act.sa_mask);
+       act.sa_flags = SA_SIGINFO;
+       sigaction(SIGRTMIN + 1, &act, NULL);
+
+       fd = open(".", O_RDONLY);
+       fcntl(fd, F_SETSIG, SIGRTMIN + 1);
+       fcntl(fd, F_NOTIFY, DN_MODIFY|DN_CREATE|DN_MULTISHOT);
+       /* we will now be notified if any of the files
+          in "." is modified or new files are created */
+       while (1) {
+               pause();
+               printf("Got event on fd=%d\n", event_fd);
+       }
+}