On Thu, 2018-04-19 at 11:49 +0100, Ian Stokes wrote: > The link used for IBM Style Guide is no longer valid. As there is no > longer a valid link via redbooks remove the url to avoid make > check-docs failing. > > Cc: Stephen Finucane <[email protected]> > Fixes: 26ea2d409 ("docs: Add writing guide") > Signed-off-by: Ian Stokes <[email protected]> > --- > Documentation/internals/contributing/documentation-style.rst | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/Documentation/internals/contributing/documentation-style.rst > b/Documentation/internals/contributing/documentation-style.rst > index 9c47bd6..047f195 100644 > --- a/Documentation/internals/contributing/documentation-style.rst > +++ b/Documentation/internals/contributing/documentation-style.rst > @@ -358,8 +358,7 @@ Writing Style > ------------- > > Follow these guidelines to ensure readability and consistency of the Open > -vSwitch documentation. These guidelines are based on the `IBM Style Guide > -<http://www.redbooks.ibm.com/Redbooks.nsf/ibmpressisbn/9780132101301?Open>`__. > +vSwitch documentation. These guidelines are based on the `IBM Style Guide`.
s/`IBM Style Guide`/*IBM Style Guide*/ (I recently learnt the former means default role, which defaults to italics but could actually be anything depending on configuration. You're better off explicitly requesting italics) In addition, I did find the following links which could be used: * http://ptgmedia.pearsoncmg.com/images/9780132101301/samplepages/0132 101300.pdf * https://www.ibm.com/developerworks/library/styleguidelines/ (for developerWorks, but the ideas are the same) * https://www.safaribooksonline.com/library/view/the-ibm-style/9780132 118989/ (paywall) We could use any of these, if we chose. However, italics aside, I'm still happy with this as-is so... Acked-by: Stephen Finucane <[email protected]> > - Use standard US English > _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
