Project

General

Profile

Actions
Copy link

Bug #13872

closed

Multiple errors in section 3mpapi of the manual

Added by Peter Tribble 3 months ago. Updated 3 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Peter Tribble
Category:
manpage - manual pages
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:
1546

Description

There are multiple errors under man3mpapi, many typos, errant spaces and line breaks.

Some examples, likely not an exhaustive list:

MP_DeregisterForObjectPropertyChanges.3mpapi
typo parmeter (4 times)

MP_DeregisterForObjectVisibilityChanges.3mpapi
typo deregistesr

MP_DeregisterPlugin.3mpapi
Missing space between pPluginId & parameter

MP_DisableAutoFailback.3mpapi
MP_DisableAutoProbing.3mpap
"MP_OBJE CT_TYPE_PLUGIN"

MP_EnableAutoFailback.3mpapi
Extra "kkk" text

MP_EnableAutoFailback.3mpapi
Extra space between "type" and "."
Extra space in the middle of "API"
Line break in the middle of MP_OBJE CT_TYPE_PLUGIN
MP_STATUS_SUCCESS missing trailing .

MP_GetAssociatedPathOidList.3mpapi
"mult ipath"
"logica l"

MP_GetDeviceProductOidList.3mpapi
missing space after "than"

MP_GetDeviceProductProperties.3mpapi
"MP_DEVICE_PR ODUCT_PROPERTIES"

MP_GetInitiatorPortOidList.3mpapi
missing space after "an"

MP_GetInitiatorPortOidList.3mpapi
MP_GetMPLuOidListFromTPG.3mpapi
pplist should be ppList

P_GetPluginProperties.3mpapi
"MP_PLUGIN_PR OPERTIES"

MP_GetTargetPortProperties.3mpapi
typo targrt should be target

MP_SetLogicalUnitLoadBalanceType.3mpapi
logicalUnitoid should be logicalUnitOid

MP_SetProprietaryProperties.3mpapi
missing space after "than"
PROPIETARY should be PROPRIETARY

Sun_MP_SendScsiCmd.3mpapi
attributes(5) should be uscsi(7I)

Sun_MP_SendScsiCmd.3mpapi:#include <mpapi_sun.h>
libMPAPI.3lib:#include <\fBmpapi_sun.h\fR>
should be mpapi-sun.h

Actions
Copy link
 #1

Updated by Electric Monk 3 months ago

  • Gerrit CR set to 1546
Actions
Copy link
 #2

Updated by Peter Tribble 3 months ago

Tested by manually viewing using the man(1) utility.

Actions
Copy link
 #3

Updated by Electric Monk 3 months ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit ceab728f83b0af9260d2d3fb69014f3781af2101

commit  ceab728f83b0af9260d2d3fb69014f3781af2101
Author: Peter Tribble <peter.tribble@gmail.com>
Date:   2021-06-15T07:32:08.000Z

    13872 Multiple errors in section 3mpapi of the manual
    Reviewed by: Toomas Soome <tsoome@me.com>
    Reviewed by: Matt Fiddaman <illumos@m.fiddaman.uk>
    Reviewed by: Richard Lowe <richlowe@richlowe.net>
    Approved by: Gordon Ross <gordon.w.ross@gmail.com>

Actions
Copy link

Also available in: Atom PDF