Linux Archive

Linux Archive (http://www.linux-archive.org/)
-   Cluster Development (http://www.linux-archive.org/cluster-development/)
-   -   gfs2_edit: Some comment cleanups (http://www.linux-archive.org/cluster-development/698486-gfs2_edit-some-comment-cleanups.html)

Andrew Price 08-28-2012 03:36 PM

gfs2_edit: Some comment cleanups
 
Remove some empty function comments to make things a bit more readable.

Signed-off-by: Andrew Price <anprice@redhat.com>
---
gfs2/edit/extended.c | 45 ----------------------------------
gfs2/edit/gfs2hex.c | 68 +++-------------------------------------------------
gfs2/edit/hexedit.c | 10 --------
3 files changed, 3 insertions(+), 120 deletions(-)

diff --git a/gfs2/edit/extended.c b/gfs2/edit/extended.c
index e2567a5..17372ae 100644
--- a/gfs2/edit/extended.c
+++ b/gfs2/edit/extended.c
@@ -30,9 +30,6 @@
static void print_block_details(struct iinfo *ind, int level, int cur_height,
int pndx, uint64_t file_offset);

-/* ------------------------------------------------------------------------ */
-/* get_height */
-/* ------------------------------------------------------------------------ */
static int get_height(void)
{
int cur_height = 0, i;
@@ -49,9 +46,6 @@ static int get_height(void)
return cur_height;
}

-/* ------------------------------------------------------------------------ */
-/* _do_indirect_extended */
-/* ------------------------------------------------------------------------ */
static int _do_indirect_extended(char *diebuf, struct iinfo *iinf, int hgt)
{
unsigned int x, y;
@@ -81,9 +75,6 @@ static int _do_indirect_extended(char *diebuf, struct iinfo *iinf, int hgt)
return i_blocks;
}

-/* ------------------------------------------------------------------------ */
-/* do_indirect_extended */
-/* ------------------------------------------------------------------------ */
int do_indirect_extended(char *diebuf, struct iinfo *iinf)
{
return _do_indirect_extended(diebuf, iinf, get_height());
@@ -107,9 +98,6 @@ static int dinode_valid(void)
return 0;
}

-/* ------------------------------------------------------------------------ */
-/* metapath_to_lblock - convert from metapath, height to logical block */
-/* ------------------------------------------------------------------------ */
static uint64_t metapath_to_lblock(struct metapath *mp, int hgt)
{
int h;
@@ -128,9 +116,6 @@ static uint64_t metapath_to_lblock(struct metapath *mp, int hgt)
return lblock;
}

-/* ------------------------------------------------------------------------ */
-/* display_indirect */
-/* ------------------------------------------------------------------------ */
static int display_indirect(struct iinfo *ind, int indblocks, int level,
uint64_t startoff)
{
@@ -246,9 +231,6 @@ static int display_indirect(struct iinfo *ind, int indblocks, int level,
return 0;
}

-/* ------------------------------------------------------------------------ */
-/* print_inode_type */
-/* ------------------------------------------------------------------------ */
static void print_inode_type(__be16 de_type)
{
if (sbd.gfs1) {
@@ -314,9 +296,6 @@ static void print_inode_type(__be16 de_type)
}
}

-/* ------------------------------------------------------------------------ */
-/* display_leaf - display directory leaf */
-/* ------------------------------------------------------------------------ */
static int display_leaf(struct iinfo *ind)
{
int start_line, total_dirents = start_row[dmode];
@@ -374,9 +353,6 @@ static int display_leaf(struct iinfo *ind)
return 0;
}

-/* ------------------------------------------------------------------------ */
-/* print_block_details */
-/* ------------------------------------------------------------------------ */
static void print_block_details(struct iinfo *ind, int level, int cur_height,
int pndx, uint64_t file_offset)
{
@@ -441,9 +417,6 @@ static void print_block_details(struct iinfo *ind, int level, int cur_height,
free(more_indir);
}

-/* ------------------------------------------------------------------------ */
-/* gfs_jindex_print - print an jindex entry. */
-/* ------------------------------------------------------------------------ */
static void gfs_jindex_print(struct gfs_jindex *ji)
{
pv((unsigned long long)ji, ji_addr, "%llu", "0x%llx");
@@ -451,9 +424,6 @@ static void gfs_jindex_print(struct gfs_jindex *ji)
pv(ji, ji_pad, "%u", "0x%x");
}

-/* ------------------------------------------------------------------------ */
-/* print_jindex - print the jindex file. */
-/* ------------------------------------------------------------------------ */
static int print_jindex(struct gfs2_inode *dij)
{
int error, start_line;
@@ -494,9 +464,6 @@ static int print_jindex(struct gfs2_inode *dij)
return error;
}

-/* ------------------------------------------------------------------------ */
-/* parse_rindex - print the rgindex file. */
-/* ------------------------------------------------------------------------ */
static int parse_rindex(struct gfs2_inode *dip, int print_rindex)
{
int error, start_line;
@@ -562,9 +529,6 @@ static int parse_rindex(struct gfs2_inode *dip, int print_rindex)
return error;
}

-/* ------------------------------------------------------------------------ */
-/* print_inum - print the inum file. */
-/* ------------------------------------------------------------------------ */
static int print_inum(struct gfs2_inode *dii)
{
uint64_t inum, inodenum;
@@ -587,9 +551,6 @@ static int print_inum(struct gfs2_inode *dii)
return 0;
}

-/* ------------------------------------------------------------------------ */
-/* print_statfs - print the statfs file. */
-/* ------------------------------------------------------------------------ */
static int print_statfs(struct gfs2_inode *dis)
{
struct gfs2_statfs_change sfb, sfc;
@@ -613,9 +574,6 @@ static int print_statfs(struct gfs2_inode *dis)
return 0;
}

-/* ------------------------------------------------------------------------ */
-/* print_quota - print the quota file. */
-/* ------------------------------------------------------------------------ */
static int print_quota(struct gfs2_inode *diq)
{
struct gfs2_quota qbuf, q;
@@ -642,9 +600,6 @@ static int print_quota(struct gfs2_inode *diq)
return 0;
}

-/* ------------------------------------------------------------------------ */
-/* display_extended */
-/* ------------------------------------------------------------------------ */
int display_extended(void)
{
struct gfs2_inode *tmp_inode;
diff --git a/gfs2/edit/gfs2hex.c b/gfs2/edit/gfs2hex.c
index 41630f9..6979cd9 100644
--- a/gfs2/edit/gfs2hex.c
+++ b/gfs2/edit/gfs2hex.c
@@ -19,7 +19,6 @@

#include "extended.h"
#include "gfs2hex.h"
-/* from libgfs2: */
#include "libgfs2.h"

#define pv(struct, member, fmt, fmt2) do {
@@ -255,21 +254,6 @@ static int indirect_dirent(struct indirect_info *indir, char *ptr, int d)
return de.de_rec_len;
}

-/************************************************** ****************************
-************************************************** *****************************
-**
-** do_dinode_extended()
-**
-** Description:
-**
-** Input(s):
-**
-** Output(s):
-**
-** Returns:
-**
-************************************************** *****************************
-************************************************** ****************************/
void do_dinode_extended(struct gfs2_dinode *dine, struct gfs2_buffer_head *lbh)
{
unsigned int x, y, ptroff = 0;
@@ -350,21 +334,9 @@ void do_dinode_extended(struct gfs2_dinode *dine, struct gfs2_buffer_head *lbh)
} /* if exhash */
}/* do_dinode_extended */

-/************************************************** ****************************
-************************************************** *****************************
-**
-** do_leaf_extended()
-**
-** Description:
-**
-** Input(s):
-**
-** Output(s):
-**
-** Returns: next leaf block, if any, in a chain of leaf blocks
-**
-************************************************** *****************************
-************************************************** ****************************/
+/**
+ * Returns: next leaf block, if any, in a chain of leaf blocks
+ */
uint64_t do_leaf_extended(char *dlebuf, struct iinfo *indir)
{
int x, i;
@@ -403,23 +375,6 @@ uint64_t do_leaf_extended(char *dlebuf, struct iinfo *indir)
return leaf.lf_next;
}

-
-/************************************************** ****************************
-************************************************** *****************************
-**
-** do_eattr_extended()
-**
-** Description:
-**
-** Input(s):
-**
-** Output(s):
-**
-** Returns:
-**
-************************************************** *****************************
-************************************************** ****************************/
-
static void do_eattr_extended(struct gfs2_buffer_head *ebh)
{
struct gfs2_ea_header ea;
@@ -524,23 +479,6 @@ static void gfs1_rgrp_print(struct gfs1_rgrp *rg)
pv(rg, rg_freemeta, "%u", "0x%x");
}

-/************************************************** ****************************
-************************************************** *****************************
-**
-** int display_gfs2()
-**
-** Description:
-** This routine...
-**
-** Input(s):
-** *buffer -
-** extended -
-**
-** Returns:
-** 0 if OK, 1 on error.
-**
-************************************************** *****************************
-************************************************** ****************************/
int display_gfs2(void)
{
struct gfs2_meta_header mh;
diff --git a/gfs2/edit/hexedit.c b/gfs2/edit/hexedit.c
index 79082b8..ff0dca9 100644
--- a/gfs2/edit/hexedit.c
+++ b/gfs2/edit/hexedit.c
@@ -3101,16 +3101,6 @@ static void process_parameters(int argc, char *argv[], int pass)
} /* for */
}/* process_parameters */

-/************************************************** ****************************
-************************************************** *****************************
-**
-** main()
-**
-** Description:
-** Do everything
-**
-************************************************** *****************************
-************************************************** ****************************/
int main(int argc, char *argv[])
{
int i, j, fd;
--
1.7.11.4

Steven Whitehouse 08-28-2012 05:35 PM

gfs2_edit: Some comment cleanups
 
Hi,

Those three all look ok to me,

Steve.

On Tue, 2012-08-28 at 16:36 +0100, Andrew Price wrote:
> Remove some empty function comments to make things a bit more readable.
>
> Signed-off-by: Andrew Price <anprice@redhat.com>
> ---
> gfs2/edit/extended.c | 45 ----------------------------------
> gfs2/edit/gfs2hex.c | 68 +++-------------------------------------------------
> gfs2/edit/hexedit.c | 10 --------
> 3 files changed, 3 insertions(+), 120 deletions(-)
>
> diff --git a/gfs2/edit/extended.c b/gfs2/edit/extended.c
> index e2567a5..17372ae 100644
> --- a/gfs2/edit/extended.c
> +++ b/gfs2/edit/extended.c
> @@ -30,9 +30,6 @@
> static void print_block_details(struct iinfo *ind, int level, int cur_height,
> int pndx, uint64_t file_offset);
>
> -/* ------------------------------------------------------------------------ */
> -/* get_height */
> -/* ------------------------------------------------------------------------ */
> static int get_height(void)
> {
> int cur_height = 0, i;
> @@ -49,9 +46,6 @@ static int get_height(void)
> return cur_height;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* _do_indirect_extended */
> -/* ------------------------------------------------------------------------ */
> static int _do_indirect_extended(char *diebuf, struct iinfo *iinf, int hgt)
> {
> unsigned int x, y;
> @@ -81,9 +75,6 @@ static int _do_indirect_extended(char *diebuf, struct iinfo *iinf, int hgt)
> return i_blocks;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* do_indirect_extended */
> -/* ------------------------------------------------------------------------ */
> int do_indirect_extended(char *diebuf, struct iinfo *iinf)
> {
> return _do_indirect_extended(diebuf, iinf, get_height());
> @@ -107,9 +98,6 @@ static int dinode_valid(void)
> return 0;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* metapath_to_lblock - convert from metapath, height to logical block */
> -/* ------------------------------------------------------------------------ */
> static uint64_t metapath_to_lblock(struct metapath *mp, int hgt)
> {
> int h;
> @@ -128,9 +116,6 @@ static uint64_t metapath_to_lblock(struct metapath *mp, int hgt)
> return lblock;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* display_indirect */
> -/* ------------------------------------------------------------------------ */
> static int display_indirect(struct iinfo *ind, int indblocks, int level,
> uint64_t startoff)
> {
> @@ -246,9 +231,6 @@ static int display_indirect(struct iinfo *ind, int indblocks, int level,
> return 0;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* print_inode_type */
> -/* ------------------------------------------------------------------------ */
> static void print_inode_type(__be16 de_type)
> {
> if (sbd.gfs1) {
> @@ -314,9 +296,6 @@ static void print_inode_type(__be16 de_type)
> }
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* display_leaf - display directory leaf */
> -/* ------------------------------------------------------------------------ */
> static int display_leaf(struct iinfo *ind)
> {
> int start_line, total_dirents = start_row[dmode];
> @@ -374,9 +353,6 @@ static int display_leaf(struct iinfo *ind)
> return 0;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* print_block_details */
> -/* ------------------------------------------------------------------------ */
> static void print_block_details(struct iinfo *ind, int level, int cur_height,
> int pndx, uint64_t file_offset)
> {
> @@ -441,9 +417,6 @@ static void print_block_details(struct iinfo *ind, int level, int cur_height,
> free(more_indir);
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* gfs_jindex_print - print an jindex entry. */
> -/* ------------------------------------------------------------------------ */
> static void gfs_jindex_print(struct gfs_jindex *ji)
> {
> pv((unsigned long long)ji, ji_addr, "%llu", "0x%llx");
> @@ -451,9 +424,6 @@ static void gfs_jindex_print(struct gfs_jindex *ji)
> pv(ji, ji_pad, "%u", "0x%x");
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* print_jindex - print the jindex file. */
> -/* ------------------------------------------------------------------------ */
> static int print_jindex(struct gfs2_inode *dij)
> {
> int error, start_line;
> @@ -494,9 +464,6 @@ static int print_jindex(struct gfs2_inode *dij)
> return error;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* parse_rindex - print the rgindex file. */
> -/* ------------------------------------------------------------------------ */
> static int parse_rindex(struct gfs2_inode *dip, int print_rindex)
> {
> int error, start_line;
> @@ -562,9 +529,6 @@ static int parse_rindex(struct gfs2_inode *dip, int print_rindex)
> return error;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* print_inum - print the inum file. */
> -/* ------------------------------------------------------------------------ */
> static int print_inum(struct gfs2_inode *dii)
> {
> uint64_t inum, inodenum;
> @@ -587,9 +551,6 @@ static int print_inum(struct gfs2_inode *dii)
> return 0;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* print_statfs - print the statfs file. */
> -/* ------------------------------------------------------------------------ */
> static int print_statfs(struct gfs2_inode *dis)
> {
> struct gfs2_statfs_change sfb, sfc;
> @@ -613,9 +574,6 @@ static int print_statfs(struct gfs2_inode *dis)
> return 0;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* print_quota - print the quota file. */
> -/* ------------------------------------------------------------------------ */
> static int print_quota(struct gfs2_inode *diq)
> {
> struct gfs2_quota qbuf, q;
> @@ -642,9 +600,6 @@ static int print_quota(struct gfs2_inode *diq)
> return 0;
> }
>
> -/* ------------------------------------------------------------------------ */
> -/* display_extended */
> -/* ------------------------------------------------------------------------ */
> int display_extended(void)
> {
> struct gfs2_inode *tmp_inode;
> diff --git a/gfs2/edit/gfs2hex.c b/gfs2/edit/gfs2hex.c
> index 41630f9..6979cd9 100644
> --- a/gfs2/edit/gfs2hex.c
> +++ b/gfs2/edit/gfs2hex.c
> @@ -19,7 +19,6 @@
>
> #include "extended.h"
> #include "gfs2hex.h"
> -/* from libgfs2: */
> #include "libgfs2.h"
>
> #define pv(struct, member, fmt, fmt2) do {
> @@ -255,21 +254,6 @@ static int indirect_dirent(struct indirect_info *indir, char *ptr, int d)
> return de.de_rec_len;
> }
>
> -/************************************************** ****************************
> -************************************************** *****************************
> -**
> -** do_dinode_extended()
> -**
> -** Description:
> -**
> -** Input(s):
> -**
> -** Output(s):
> -**
> -** Returns:
> -**
> -************************************************** *****************************
> -************************************************** ****************************/
> void do_dinode_extended(struct gfs2_dinode *dine, struct gfs2_buffer_head *lbh)
> {
> unsigned int x, y, ptroff = 0;
> @@ -350,21 +334,9 @@ void do_dinode_extended(struct gfs2_dinode *dine, struct gfs2_buffer_head *lbh)
> } /* if exhash */
> }/* do_dinode_extended */
>
> -/************************************************** ****************************
> -************************************************** *****************************
> -**
> -** do_leaf_extended()
> -**
> -** Description:
> -**
> -** Input(s):
> -**
> -** Output(s):
> -**
> -** Returns: next leaf block, if any, in a chain of leaf blocks
> -**
> -************************************************** *****************************
> -************************************************** ****************************/
> +/**
> + * Returns: next leaf block, if any, in a chain of leaf blocks
> + */
> uint64_t do_leaf_extended(char *dlebuf, struct iinfo *indir)
> {
> int x, i;
> @@ -403,23 +375,6 @@ uint64_t do_leaf_extended(char *dlebuf, struct iinfo *indir)
> return leaf.lf_next;
> }
>
> -
> -/************************************************** ****************************
> -************************************************** *****************************
> -**
> -** do_eattr_extended()
> -**
> -** Description:
> -**
> -** Input(s):
> -**
> -** Output(s):
> -**
> -** Returns:
> -**
> -************************************************** *****************************
> -************************************************** ****************************/
> -
> static void do_eattr_extended(struct gfs2_buffer_head *ebh)
> {
> struct gfs2_ea_header ea;
> @@ -524,23 +479,6 @@ static void gfs1_rgrp_print(struct gfs1_rgrp *rg)
> pv(rg, rg_freemeta, "%u", "0x%x");
> }
>
> -/************************************************** ****************************
> -************************************************** *****************************
> -**
> -** int display_gfs2()
> -**
> -** Description:
> -** This routine...
> -**
> -** Input(s):
> -** *buffer -
> -** extended -
> -**
> -** Returns:
> -** 0 if OK, 1 on error.
> -**
> -************************************************** *****************************
> -************************************************** ****************************/
> int display_gfs2(void)
> {
> struct gfs2_meta_header mh;
> diff --git a/gfs2/edit/hexedit.c b/gfs2/edit/hexedit.c
> index 79082b8..ff0dca9 100644
> --- a/gfs2/edit/hexedit.c
> +++ b/gfs2/edit/hexedit.c
> @@ -3101,16 +3101,6 @@ static void process_parameters(int argc, char *argv[], int pass)
> } /* for */
> }/* process_parameters */
>
> -/************************************************** ****************************
> -************************************************** *****************************
> -**
> -** main()
> -**
> -** Description:
> -** Do everything
> -**
> -************************************************** *****************************
> -************************************************** ****************************/
> int main(int argc, char *argv[])
> {
> int i, j, fd;

Bob Peterson 08-28-2012 05:50 PM

gfs2_edit: Some comment cleanups
 
----- Original Message -----
| Remove some empty function comments to make things a bit more
| readable.
|
| Signed-off-by: Andrew Price <anprice@redhat.com>
| ---

Hi,

ACK to all three patches.

Regards,

Bob Peterson
Red Hat File Systems


All times are GMT. The time now is 10:47 AM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.