Skip to content

Commit 33e1d4d

Browse files
committed
Change 'Mac OS X' to 'macOS' in the documentation.
1 parent 610c8d2 commit 33e1d4d

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ if (POLICY CMP0025)
55
cmake_policy(SET CMP0025 NEW)
66
endif ()
77

8-
# Fix a warning on Mac OS X.
8+
# Fix a warning on macOS.
99
if (POLICY CMP0042)
1010
cmake_policy(SET CMP0042 NEW)
1111
endif ()

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ The following tools are used to help build, test, debug, and document this libra
1010
- [Doxygen](http://www.stack.nl/~dimitri/doxygen/)
1111
- Development environments:
1212
- Windows: [MSYS2](http://msys2.github.io/)
13-
- Mac OS X: [Homebrew](http://brew.sh/)
13+
- macOS: [Homebrew](http://brew.sh/)
1414
- Memory leak checkers:
1515
- Windows: Install Dr. Memory and run `drmemory -leaks_only ./run_test.exe`
1616
- Linux: Install Valgrind and run `valgrind ./run_test`
17-
- Mac OS X: Run `MallocStackLogging=1 ./run_test -p`, wait for the tests to finish, press Ctrl+Z, run `leaks run_test`, then finally run `fg` to go back to the stopped test process and end it.
17+
- macOS: Run `MallocStackLogging=1 ./run_test -p`, wait for the tests to finish, press Ctrl+Z, run `leaks run_test`, then finally run `fg` to go back to the stopped test process and end it.
1818

1919
## Underlying API documentation
2020

@@ -49,7 +49,7 @@ This section attempts to organize the documentation and information about the un
4949
- [errno.h](https://github.com/torvalds/linux/blob/master/include/uapi/asm-generic/errno.h)
5050
- [errno-base.h](https://github.com/torvalds/linux/blob/master/include/uapi/asm-generic/errno-base.h)
5151

52-
### Mac OS X APIs
52+
### macOS APIs
5353

5454
- [I/O Kit Framework Reference](https://developer.apple.com/library/mac/documentation/Darwin/Reference/IOKit/index.html#//apple_ref/doc/uid/TP30000815)
5555
- [IOKitLib.h Reference](https://developer.apple.com/library/mac/documentation/IOKit/Reference/IOKitLib_header_reference/)

PLATFORM_NOTES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ On Linux, a udev rule is typically needed in order to grant permissions for non-
1111

1212
## Multiple handles to the same generic interface
1313

14-
On Linux, you can have multiple simultaneous handles open to the same generic interface of a device. On Windows and Mac OS X, this is not possible, and you will get an error with the code `LIBUSBP_ERROR_ACCESS_DENIED` when trying to open the second handle with `libusbp_generic_handle_open`.
14+
On Linux, you can have multiple simultaneous handles open to the same generic interface of a device. On Windows and macOS, this is not possible, and you will get an error with the code `LIBUSBP_ERROR_ACCESS_DENIED` when trying to open the second handle with `libusbp_generic_handle_open`.
1515

1616

1717
## Timeouts for interrupt IN endpoints
1818

19-
On Mac OS X, you cannot specify a timeout for an interrupt IN endpoint. Doing so will result in the following error when you try to read from the endpoint:
19+
On macOS, you cannot specify a timeout for an interrupt IN endpoint. Doing so will result in the following error when you try to read from the endpoint:
2020

2121
Failed to read from pipe. (iokit/common) invalid argument. Error code 0xe00002c2.
2222

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The library runs on:
2626

2727
* Microsoft Windows (Windows Vista and later)
2828
* Linux
29-
* Mac OS X (10.11 and later)
29+
* macOS (10.11 and later)
3030

3131

3232
## Supported USB devices and interfaces
@@ -91,9 +91,9 @@ Download the source code of this library and navigate to the top-level directory
9191
sudo make install
9292

9393

94-
## Building from source on Mac OS X
94+
## Building from source on macOS
9595

96-
First, install [Homebrew](http://brew.sh/), a package manager for Mac OS X. Then use Homebrew to install CMake by running the following command in a Terminal:
96+
First, install [Homebrew](http://brew.sh/), a package manager for macOS. Then use Homebrew to install CMake by running the following command in a Terminal:
9797

9898
brew install cmake
9999

include/libusbp.h

+7-7
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ libusbp_error * libusbp_device_get_serial_number(
369369
* /sys/devices/pci0000:00/0000:00:06.0/usb1/1-2
370370
* </pre>
371371
*
372-
* <b>Mac OS X:</b> This will be an integer from
372+
* <b>macOS:</b> This will be an integer from
373373
* IORegistryEntryGetRegistryEntryID, formatted as a lower-case hex number with
374374
* no leading zeros. It will look something like this:
375375
*
@@ -409,7 +409,7 @@ typedef struct libusbp_generic_interface
409409
* code LIBUSBP_ERROR_NOT_READY is returned. If the interface is assigned to a
410410
* driver that is not "usbfs", an error is returned.
411411
*
412-
* On Mac OS X, we do not have any additional checks beyond just making sure
412+
* On macOS, we do not have any additional checks beyond just making sure
413413
* that an entry for the interface is found. For non-composite devices, that
414414
* check is deferred until a handle is opened.
415415
*
@@ -455,7 +455,7 @@ libusbp_error * libusbp_generic_interface_copy(
455455
* /sys/devices/pci0000:00/0000:00:06.0/usb1/1-2/1-2:1.0
456456
* </pre>
457457
*
458-
* <b>Mac OS X:</b> This will be an integer from
458+
* <b>macOS:</b> This will be an integer from
459459
* IORegistryEntryGetRegistryEntryID, formatted as a lower-case hex number with
460460
* no leading zeros. It will look something like this:
461461
*
@@ -485,7 +485,7 @@ libusbp_error * libusbp_generic_interface_get_os_id(
485485
* /dev/bus/usb/001/007
486486
* </pre>
487487
*
488-
* <b>Mac OS X:</b> This will be an integer from
488+
* <b>macOS:</b> This will be an integer from
489489
* IORegistryEntryGetRegistryEntryID, formatted as a lower-case hex number with
490490
* no leading zeros. It will look something like this:
491491
*
@@ -520,7 +520,7 @@ typedef struct libusbp_generic_handle
520520
* open already when this function is called, then this function will fail and
521521
* the returned error will have code ::LIBUSBP_ERROR_ACCESS_DENIED.
522522
*
523-
* On Mac OS X, this function will set the device's configuration to 1 as a
523+
* On macOS, this function will set the device's configuration to 1 as a
524524
* side effect in case it is not already configured. */
525525
LIBUSBP_API LIBUSBP_WARN_UNUSED
526526
libusbp_error * libusbp_generic_handle_open(
@@ -682,7 +682,7 @@ typedef struct libusbp_serial_port
682682
* is returned with the code LIBUSBP_ERROR_NOT_READY, because this could just be
683683
* a temporary condition that happens right after the device is plugged in.
684684
*
685-
* On Mac OS X, it is assumed that the interface with a @a bInterfaceNumber one
685+
* On macOS, it is assumed that the interface with a @a bInterfaceNumber one
686686
* greater than @a interface_number is the interface that the IOSerialBSDClient
687687
* will attach to. This should be true if the device implements the USB CDC ACM
688688
* class and has ordered its interfaces so that the control interface is right
@@ -720,7 +720,7 @@ libusbp_error * libusbp_serial_port_copy(
720720
*
721721
* On Linux, it will be something like "/dev/ttyACM0".
722722
*
723-
* On Mac OS X, it will be something like "/dev/cu.usbmodem012345".
723+
* On macOS, it will be something like "/dev/cu.usbmodem012345".
724724
* Specifically, it will be a call-out device, not a dial-in device.
725725
*
726726
* You should free the returned string by calling libusbp_string_free().

0 commit comments

Comments
 (0)