[LU-4975] Doxygen comments - ofd module

• Status: Resolved
• Project: Lustre
• Fix Version/s: Lustre 2.7.0
• Type: Technical task
• Priority: Minor
• Reporter: Andreas Dilger
• Assignee: Richard Henwood (Inactive)
• Resolution: Fixed

Description

Bug to track development and landing of code comments for the lustre/ofd module.

Comments

[Andreas Dilger]

ofd_fs.c: http://review.whamcloud.com/10417

[Johann Lombardi (Inactive)]

ofd_grant.c: http://review.whamcloud.com/#/c/10586

[Lai Siyao]

ofd_capa.c: http://review.whamcloud.com/10606

[Lai Siyao]

lproc_osp.c: http://review.whamcloud.com/#/c/10893/

[Ned Bass]

Please correct the following.

ofd_grant.c:

/home/bass6/lustre/lustre/ofd/ofd_grant.c:480: warning: argument 'niocont' of command @param is not found in the argument list of ofd_grant_check(const struct lu_env *env, struct obd_export *exp, struct obdo *oa, struct niobuf_remote *rnb, int niocount, obd_size *left)
/home/bass6/lustre/lustre/ofd/ofd_grant.c:480: warning: The following parameters of ofd_grant_check(const struct lu_env *env, struct obd_export *exp, struct obdo *oa, struct niobuf_remote *rnb, int niocount, obd_size *left) are not documented:
  parameter 'niocount'
/home/bass6/lustre/lustre/ofd/ofd_grant.c:1109: warning: The following parameters of ofd_grant_commit(const struct lu_env *env, struct obd_export *exp, int rc) are not documented:
  parameter 'rc'
/home/bass6/lustre/lustre/ofd/ofd_grant.c:850: warning: Found unknown command `\paral'
/home/bass6/lustre/lustre/ofd/ofd_grant.c:842: warning: The following parameters of ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp, struct obdo *oa) are not documented:
  parameter 'oa'
/home/bass6/lustre/lustre/ofd/ofd_grant.c:909: warning: argument 'niocont' of command @param is not found in the argument list of ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp, struct obdo *oa, struct niobuf_remote *rnb, int niocount)
/home/bass6/lustre/lustre/ofd/ofd_grant.c:909: warning: The following parameters of ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp, struct obdo *oa, struct niobuf_remote *rnb, int niocount) are not documented:
  parameter 'niocount'

ofd_fs.c

/home/bass6/lustre/lustre/ofd/ofd_fs.c:49: warning: argument 'int' of command @param is not found in the argument list of ofd_precreate_batch(struct ofd_device *ofd, int batch)
/home/bass6/lustre/lustre/ofd/ofd_fs.c:49: warning: The following parameters of ofd_precreate_batch(struct ofd_device *ofd, int batch) are not documented:
  parameter 'batch'
/home/bass6/lustre/lustre/ofd/ofd_fs.c:157: warning: argument 'ofd_seq' of command @param is not found in the argument list of ofd_seq_last_oid(struct ofd_seq *oseq)
/home/bass6/lustre/lustre/ofd/ofd_fs.c:157: warning: The following parameters of ofd_seq_last_oid(struct ofd_seq *oseq) are not documented:
  parameter 'oseq'

[Doug Oucharek (Inactive)]

Warnings addressed in patch: http://review.whamcloud.com/12665

[Gerrit Updater]

Oleg Drokin ([e-mail]) merged in patch http://review.whamcloud.com/12665/
Subject: LU-4975 ofd: Fix Doxygen warnings for ofd files
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: 422ea5a9a0ef7677ed01b69cd3a5f0e324cd069f