[PATCH 2/2] documentation: split and build dnotify_test program

[PATCH 2/2] documentation: split and build dnotify_test program

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

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>
---
 Documentation/filesystems/00-INDEX       |    2 +
 Documentation/filesystems/Makefile       |    2 -
 Documentation/filesystems/dnotify.txt    |   36 -------------------------------
 Documentation/filesystems/dnotify_test.c |   34 +++++++++++++++++++++++++++++
 4 files changed, 38 insertions(+), 36 deletions(-)

--- lin2627-rc3g4-kerndoc.orig/Documentation/filesystems/Makefile
+++ lin2627-rc3g4-kerndoc/Documentation/filesystems/Makefile
@@ -2,7 +2,7 @@
 obj- := dummy.o
 
 # List of programs to build
-hostprogs-y := smount
+hostprogs-y := smount dnotify_test
 
 # Tell kbuild to always build the programs
 always := $(hostprogs-y)
--- lin2627-rc3g4-kerndoc.orig/Documentation/filesystems/dnotify.txt
+++ lin2627-rc3g4-kerndoc/Documentation/filesystems/dnotify.txt
@@ -62,38 +62,4 @@ disabled, fcntl(fd, F_NOTIFY, ...) will 
 
 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);
-		}
-	}
+See Documentation/filesystems/dnotify_test.c for an example.
--- /dev/null
+++ lin2627-rc3g4-kerndoc/Documentation/filesystems/dnotify_test.c
@@ -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);
+	}
+}
--- lin2627-rc3g4-kerndoc.orig/Documentation/filesystems/00-INDEX
+++ lin2627-rc3g4-kerndoc/Documentation/filesystems/00-INDEX
@@ -34,6 +34,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.
 ext2.txt


---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/

Re: [PATCH 2/2] documentation: split and build dnotify_test program

[Karel Zak]

On Sun, Aug 17, 2008 at 09:44:56PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> 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>
> ---
>  Documentation/filesystems/00-INDEX       |    2 +
>  Documentation/filesystems/Makefile       |    2 -
>  Documentation/filesystems/dnotify.txt    |   36 -------------------------------

 $ grep -c inotify Documentation/filesystems/dnotify.txt
 0

 It would be nice to add a note that dnotify has been obsoleted by
 inotify (>= 2.6.13).

    Karel

-- 
 Karel Zak  <kzak@redhat.com>

Re: [PATCH 2/2] documentation: split and build dnotify_test program

[Randy Dunlap]

On Wed, 20 Aug 2008 01:04:54 +0200 Karel Zak wrote:

> On Sun, Aug 17, 2008 at 09:44:56PM -0700, Randy Dunlap wrote:
> > From: Randy Dunlap <randy.dunlap@oracle.com>
> > 
> > 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>
> > ---
> >  Documentation/filesystems/00-INDEX       |    2 +
> >  Documentation/filesystems/Makefile       |    2 -
> >  Documentation/filesystems/dnotify.txt    |   36 -------------------------------
> 
>  $ grep -c inotify Documentation/filesystems/dnotify.txt
>  0
> 
>  It would be nice to add a note that dnotify has been obsoleted by
>  inotify (>= 2.6.13).

Done for upcoming patch, but using "replaced by".

---
~Randy