[riot-commits] [RIOT-OS/RIOT] 2e93ba: doc: Fix 'must not'/'may not' wording

Martine Lenders authmillenon at gmail.com
Wed Jan 10 20:34:20 CET 2018


  Branch: refs/heads/master
  Home:   https://github.com/RIOT-OS/RIOT
  Commit: 2e93ba1c504b0dbb70937c80c86f022bfa676a3a
      https://github.com/RIOT-OS/RIOT/commit/2e93ba1c504b0dbb70937c80c86f022bfa676a3a
  Author: Martine Lenders <m.lenders at fu-berlin.de>
  Date:   2017-12-19 (Tue, 19 Dec 2017)

  Changed paths:
    M core/include/lifo.h
    M sys/include/net/gnrc/ipv6/nib/nc.h
    M sys/include/net/gnrc/ipv6/nib/pl.h
    M sys/include/net/gnrc/ndp.h
    M sys/include/net/gnrc/netif/internal.h
    M sys/include/net/gnrc/pktqueue.h
    M sys/include/net/gnrc/priority_pktqueue.h
    M sys/include/net/ndp.h
    M sys/include/net/sixlowpan.h
    M sys/include/net/sixlowpan/nd.h
    M sys/include/net/sock/udp.h
    M sys/net/gnrc/network_layer/ipv6/nib/_nib-arsm.h
    M sys/net/gnrc/network_layer/ipv6/nib/_nib-internal.h

  Log Message:
  -----------
  doc: Fix 'must not'/'may not' wording

I applied the following terminology and changed the wording in the doc
accordingly:

* must not: If the parameter is of the value it *must not* be it either
  hits an assert or crashes the system.
* may not: The value can be that value, but the function will return an
  error.


  Commit: 4013adcf65a71d10970abf6d07f70ab4529badbb
      https://github.com/RIOT-OS/RIOT/commit/4013adcf65a71d10970abf6d07f70ab4529badbb
  Author: Martine Lenders <authmillenon at gmail.com>
  Date:   2018-01-10 (Wed, 10 Jan 2018)

  Changed paths:
    M core/include/lifo.h
    M sys/include/net/gnrc/ipv6/nib/nc.h
    M sys/include/net/gnrc/ipv6/nib/pl.h
    M sys/include/net/gnrc/ndp.h
    M sys/include/net/gnrc/netif/internal.h
    M sys/include/net/gnrc/pktqueue.h
    M sys/include/net/gnrc/priority_pktqueue.h
    M sys/include/net/ndp.h
    M sys/include/net/sixlowpan.h
    M sys/include/net/sixlowpan/nd.h
    M sys/include/net/sock/udp.h
    M sys/net/gnrc/network_layer/ipv6/nib/_nib-arsm.h
    M sys/net/gnrc/network_layer/ipv6/nib/_nib-internal.h

  Log Message:
  -----------
  Merge pull request #8277 from miri64/doc/fix/must-not-may-not-wording

doc: Fix 'must not'/'may not' wording


Compare: https://github.com/RIOT-OS/RIOT/compare/f78b409e7b59...4013adcf65a7


More information about the commits mailing list