From 8907f67ba215172b01a7018adcbb063fcc4570e9 Mon Sep 17 00:00:00 2001 From: Humble Devassy Chirammal Date: Mon, 30 Mar 2015 12:21:05 +0530 Subject: doc: restructure developer docs to new layout The developer oriented information is scattered in source and its very difficult to identify which are those. With this patch subdirs are created under developer-guide which will be the parent for developer notes. The changes suggested in http://review.gluster.org/#/c/8827/ are also included in this patch. Change-Id: I4c8510d52c49f4066225f72cac8f97f087d6c70c BUG: 1206539 Signed-off-by: Humble Devassy Chirammal Reviewed-on: http://review.gluster.org/10038 Tested-by: Gluster Build System Reviewed-by: Lalatendu Mohanty Reviewed-by: Kaleb KEITHLEY --- doc/developer-guide/adding-fops.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/developer-guide/adding-fops.md (limited to 'doc/developer-guide/adding-fops.md') diff --git a/doc/developer-guide/adding-fops.md b/doc/developer-guide/adding-fops.md new file mode 100644 index 0000000000..3f72ed3e23 --- /dev/null +++ b/doc/developer-guide/adding-fops.md @@ -0,0 +1,18 @@ +Adding a new FOP +================ + +Steps to be followed when adding a new FOP to GlusterFS: + +1. Edit `glusterfs.h` and add a `GF_FOP_*` constant. +2. Edit `xlator.[ch]` and: + * add the new prototype for fop and callback. + * edit `xlator_fops` structure. +3. Edit `xlator.c` and add to fill_defaults. +4. Edit `protocol.h` and add struct necessary for the new FOP. +5. Edit `defaults.[ch]` and provide default implementation. +6. Edit `call-stub.[ch]` and provide stub implementation. +7. Edit `common-utils.c` and add to gf_global_variable_init(). +8. Edit client-protocol and add your FOP. +9. Edit server-protocol and add your FOP. +10. Implement your FOP in any translator for which the default implementation + is not sufficient. -- cgit