Commit 50e865a5 authored by Randy Dunlap's avatar Randy Dunlap Committed by Juergen Gross
Browse files

xen/shbuf: eliminate 17 kernel-doc warnings 



Don't use kernel-doc markers ("/**") for comments that are not in
kernel-doc format. This prevents multiple kernel-doc warnings:

xen-front-pgdir-shbuf.c:25: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * This structure represents the structure of a shared page
xen-front-pgdir-shbuf.c:37: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Shared buffer ops which are differently implemented
xen-front-pgdir-shbuf.c:65: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Get granted reference to the very first page of the
xen-front-pgdir-shbuf.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Map granted references of the shared buffer.
xen-front-pgdir-shbuf.c:106: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Unmap granted references of the shared buffer.
xen-front-pgdir-shbuf.c:127: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Free all the resources of the shared buffer.
xen-front-pgdir-shbuf.c:154: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Get the number of pages the page directory consumes itself.
xen-front-pgdir-shbuf.c:164: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Calculate the number of grant references needed to share the buffer
xen-front-pgdir-shbuf.c:176: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Calculate the number of grant references needed to share the buffer
xen-front-pgdir-shbuf.c:194: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Unmap the buffer previously mapped with grant references
xen-front-pgdir-shbuf.c:242: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Map the buffer with grant references provided by the backend.
xen-front-pgdir-shbuf.c:324: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Fill page directory with grant references to the pages of the
xen-front-pgdir-shbuf.c:354: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Fill page directory with grant references to the pages of the
xen-front-pgdir-shbuf.c:393: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Grant references to the frontend's buffer pages.
xen-front-pgdir-shbuf.c:422: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Grant all the references needed to share the buffer.
xen-front-pgdir-shbuf.c:470: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Allocate all required structures to mange shared buffer.
xen-front-pgdir-shbuf.c:510: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Allocate a new instance of a shared buffer.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Closes: lore.kernel.org/r/202311060203.yQrpPZhm-lkp@intel.com
Acked-by: default avatarJuergen Gross <jgross@suse.com>
Cc: Juergen Gross <jgross@suse.com>
Cc: Stefano Stabellini <sstabellini@kernel.org>
Cc: Oleksandr Tyshchenko <oleksandr_tyshchenko@epam.com>
Cc: xen-devel@lists.xenproject.org
Link: https://lore.kernel.org/r/20231106055631.21520-1-rdunlap@infradead.org


Signed-off-by: default avatarJuergen Gross <jgross@suse.com>
parent bfa993b3

drivers/xen/xen-front-pgdir-shbuf.c

+17 −17
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ 


#include <xen/xen-front-pgdir-shbuf.h>



/**

/*

 * This structure represents the structure of a shared page

 * that contains grant references to the pages of the shared

 * buffer. This structure is common to many Xen para-virtualized
@@ -33,7 +33,7 @@ struct xen_page_directory { 
	grant_ref_t gref[]; /* Variable length */

};



/**

/*

 * Shared buffer ops which are differently implemented

 * depending on the allocation mode, e.g. if the buffer

 * is allocated by the corresponding backend or frontend.
@@ -61,7 +61,7 @@ struct xen_front_pgdir_shbuf_ops { 
	int (*unmap)(struct xen_front_pgdir_shbuf *buf);

};



/**

/*

 * Get granted reference to the very first page of the

 * page directory. Usually this is passed to the backend,

 * so it can find/fill the grant references to the buffer's
@@ -81,7 +81,7 @@ xen_front_pgdir_shbuf_get_dir_start(struct xen_front_pgdir_shbuf *buf) 
}

EXPORT_SYMBOL_GPL(xen_front_pgdir_shbuf_get_dir_start);



/**

/*

 * Map granted references of the shared buffer.

 *

 * Depending on the shared buffer mode of allocation
@@ -102,7 +102,7 @@ int xen_front_pgdir_shbuf_map(struct xen_front_pgdir_shbuf *buf) 
}

EXPORT_SYMBOL_GPL(xen_front_pgdir_shbuf_map);



/**

/*

 * Unmap granted references of the shared buffer.

 *

 * Depending on the shared buffer mode of allocation
@@ -123,7 +123,7 @@ int xen_front_pgdir_shbuf_unmap(struct xen_front_pgdir_shbuf *buf) 
}

EXPORT_SYMBOL_GPL(xen_front_pgdir_shbuf_unmap);



/**

/*

 * Free all the resources of the shared buffer.

 *

 * \param buf shared buffer which resources to be freed.
@@ -150,7 +150,7 @@ EXPORT_SYMBOL_GPL(xen_front_pgdir_shbuf_free); 
				 offsetof(struct xen_page_directory, \

					  gref)) / sizeof(grant_ref_t))



/**

/*

 * Get the number of pages the page directory consumes itself.

 *

 * \param buf shared buffer.
@@ -160,7 +160,7 @@ static int get_num_pages_dir(struct xen_front_pgdir_shbuf *buf) 
	return DIV_ROUND_UP(buf->num_pages, XEN_NUM_GREFS_PER_PAGE);

}



/**

/*

 * Calculate the number of grant references needed to share the buffer

 * and its pages when backend allocates the buffer.

 *
@@ -172,7 +172,7 @@ static void backend_calc_num_grefs(struct xen_front_pgdir_shbuf *buf) 
	buf->num_grefs = get_num_pages_dir(buf);

}



/**

/*

 * Calculate the number of grant references needed to share the buffer

 * and its pages when frontend allocates the buffer.

 *
@@ -190,7 +190,7 @@ static void guest_calc_num_grefs(struct xen_front_pgdir_shbuf *buf) 
#define xen_page_to_vaddr(page) \

	((uintptr_t)pfn_to_kaddr(page_to_xen_pfn(page)))



/**

/*

 * Unmap the buffer previously mapped with grant references

 * provided by the backend.

 *
@@ -238,7 +238,7 @@ static int backend_unmap(struct xen_front_pgdir_shbuf *buf) 
	return ret;

}



/**

/*

 * Map the buffer with grant references provided by the backend.

 *

 * \param buf shared buffer.
@@ -320,7 +320,7 @@ static int backend_map(struct xen_front_pgdir_shbuf *buf) 
	return ret;

}



/**

/*

 * Fill page directory with grant references to the pages of the

 * page directory itself.

 *
@@ -350,7 +350,7 @@ static void backend_fill_page_dir(struct xen_front_pgdir_shbuf *buf) 
	page_dir->gref_dir_next_page = XEN_GREF_LIST_END;

}



/**

/*

 * Fill page directory with grant references to the pages of the

 * page directory and the buffer we share with the backend.

 *
@@ -389,7 +389,7 @@ static void guest_fill_page_dir(struct xen_front_pgdir_shbuf *buf) 
	}

}



/**

/*

 * Grant references to the frontend's buffer pages.

 *

 * These will be shared with the backend, so it can
@@ -418,7 +418,7 @@ static int guest_grant_refs_for_buffer(struct xen_front_pgdir_shbuf *buf, 
	return 0;

}



/**

/*

 * Grant all the references needed to share the buffer.

 *

 * Grant references to the page directory pages and, if
@@ -466,7 +466,7 @@ static int grant_references(struct xen_front_pgdir_shbuf *buf) 
	return 0;

}



/**

/*

 * Allocate all required structures to mange shared buffer.

 *

 * \param buf shared buffer.
@@ -506,7 +506,7 @@ static const struct xen_front_pgdir_shbuf_ops local_ops = { 
	.grant_refs_for_buffer = guest_grant_refs_for_buffer,

};



/**

/*

 * Allocate a new instance of a shared buffer.

 *

 * \param cfg configuration to be used while allocating a new shared buffer.