[PATCH 0/2] spi: Fix make htmldocs issues

[PATCH 0/2] spi: Fix make htmldocs issues

[Javier Martinez Canillas]

Hello,

The make htmldocs target is broken in today's next (next-20160310) and
this is caused by an error in the SPI kernel-doc.

This small series fix that SPI kernel-doc error and also a warning that
I noticed when the docs were finally built.

Best regards,
Javier


Javier Martinez Canillas (2):
  spi: Fix htmldocs build error due struct spi_replaced_transfers
  spi: Add gfp parameter to kernel-doc to fix build warning

 drivers/spi/spi.c       | 1 +
 include/linux/spi/spi.h | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)

-- 
2.5.0

[PATCH 1/2] spi: Fix htmldocs build error due struct spi_replaced_transfers

[Javier Martinez Canillas]

The kernel-doc has to be just before the structure definition but the one
for struct spi_replaced_transfers was before a structure declaration and
that confuses kernel-doc which complains with the following build error:

.//include/linux/spi/spi.h:933: error: Cannot parse struct or union!

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
---

 include/linux/spi/spi.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h
index 520a23d46df6..857a9a1d82b5 100644
--- a/include/linux/spi/spi.h
+++ b/include/linux/spi/spi.h
@@ -911,6 +911,10 @@ spi_max_transfer_size(struct spi_device *spi)
 
 /* SPI transfer replacement methods which make use of spi_res */
 
+struct spi_replaced_transfers;
+typedef void (*spi_replaced_release_t)(struct spi_master *master,
+				       struct spi_message *msg,
+				       struct spi_replaced_transfers *res);
 /**
  * struct spi_replaced_transfers - structure describing the spi_transfer
  *                                 replacements that have occurred
@@ -930,10 +934,6 @@ spi_max_transfer_size(struct spi_device *spi)
  * if some extra allocation is requested, so alignment will be the same
  * as for spi_transfers
  */
-struct spi_replaced_transfers;
-typedef void (*spi_replaced_release_t)(struct spi_master *master,
-				       struct spi_message *msg,
-				       struct spi_replaced_transfers *res);
 struct spi_replaced_transfers {
 	spi_replaced_release_t release;
 	void *extradata;
-- 
2.5.0

[PATCH 2/2] spi: Add gfp parameter to kernel-doc to fix build warning

[Javier Martinez Canillas]

The spi_split_transfers_maxsize() gfp parameter is missing in the
function kernel-doc so building gives the following warning:

.//drivers/spi/spi.c:2359: warning: No description found for parameter 'gfp'

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>

---

 drivers/spi/spi.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/spi/spi.c b/drivers/spi/spi.c
index 78b7e899ce76..f88161247a2c 100644
--- a/drivers/spi/spi.c
+++ b/drivers/spi/spi.c
@@ -2349,6 +2349,7 @@ static int __spi_split_transfer_maxsize(struct spi_master *master,
  * @master:    the @spi_master for this transfer
  * @msg:   the @spi_message to transform
  * @maxsize:  the maximum when to apply this
+ * @gfp: GFP allocation flags
  *
  * Return: status of transformation
  */
-- 
2.5.0