document low hanging fruit to help improve code readability
Documented some changes which should help improve code readability with
FIXME.
---
drivers/md/dm-multisnap-mikulas.c | 4 ++++
drivers/md/dm-multisnap-mikulas.h | 7 +++++++
drivers/md/dm-multisnap-private.h | 5 +++++
3 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/drivers/md/dm-multisnap-mikulas.c b/drivers/md/dm-multisnap-mikulas.c
index e16c0d6..1c33dd2 100644
--- a/drivers/md/dm-multisnap-mikulas.c
+++ b/drivers/md/dm-multisnap-mikulas.c
@@ -537,11 +537,15 @@ static void print_bitmaps(struct dm_exception_store *s)
* Parse arguments, allocate structures and call read_super to read the data
* from the disk.
*/
+/* FIXME rename all 'struct dm_multisnap *dm' to be using 's' for snapshot, e.g.: */
+/* dm-multisnap-private.h:dm_multisnap_snap uses 'struct dm_multisnap *s' */
static int dm_multisnap_mikulas_init(struct dm_multisnap *dm,
struct dm_exception_store **sp,
unsigned argc, char **argv, char **error)
{
int r, i;
+ /* FIXME replace all 's' with 'ps' in entire dm-multisnap-mikulas.c */
+ /* avoids confusion with 's' being widely known as some form of snapshot in dm */
struct dm_exception_store *s;
unsigned char flags;
+ /* FIXME these flags should be defined outside the struct, like agk fixed for merge */
#define DM_MULTISNAP_SYNC_SNAPSHOTS 1
#define DM_MULTISNAP_PRESERVE_ON_ERROR 2
--
1.6.6.1
--
dm-devel mailing list
dm-devel@redhat.com
https://www.redhat.com/mailman/listinfo/dm-devel