Update documentation

This commit is contained in:
Martin Natano
2022-05-28 11:21:13 +02:00
parent be0dee1402
commit 15b77ee278
36 changed files with 133 additions and 213 deletions
+1 -1
View File
@@ -45,7 +45,7 @@ static void LuaInformation()
* @brief Print out version information.
*
* HACK: This function is primarily needed for Windows users.
* Mac OS X and Linux print out version information on the command line
* macOS and Linux print out version information on the command line
* regardless of any preferences (tested by shakesoda on Mac). -aj */
static void Version()
{
+3 -3
View File
@@ -249,7 +249,7 @@ RString HourInDayToLocalizedString( int iHourIndex )
tm AddDays( tm start, int iDaysToMove )
{
/*
* This causes problems on OS X, which doesn't correctly handle range that are below
* This causes problems on macOS, which doesn't correctly handle range that are below
* their normal values (eg. mday = 0). According to the manpage, it should adjust them:
*
* "If structure members are outside their legal interval, they will be normalized (so
@@ -263,7 +263,7 @@ tm AddDays( tm start, int iDaysToMove )
*
* Note "Log starting 2004-03-07 03:50:42"; mday is 7, and PrintCaloriesBurned calls us
* with iDaysToMove = -7, resulting in an out-of-range value 0. This seems legal, but
* OS X chokes on it.
* macOS chokes on it.
*/
/* start.tm_mday += iDaysToMove;
time_t seconds = mktime( &start );
@@ -302,7 +302,7 @@ tm GetNextSunday( tm start )
tm GetDayInYearAndYear( int iDayInYearIndex, int iYear )
{
/* If iDayInYearIndex is 200, set the date to Jan 200th, and let mktime
* round it. This shouldn't suffer from the OSX mktime() issue described
* round it. This shouldn't suffer from the macOS mktime() issue described
* above, since we're not giving it negative values. */
tm when;
ZERO( when );
+1 -1
View File
@@ -540,7 +540,7 @@ void RageFileManager::GetDirListing( const RString &sPath_, vector<RString> &Add
UnreferenceAllDrivers( apDriverList );
// Remove files that start with ._ from the list because these are special
// OS X files that cause interference on other platforms. -Kyz
// macOS files that cause interference on other platforms. -Kyz
StripMacResourceForks(AddTo);
if( iDriversThatReturnedFiles > 1 )
+1 -1
View File
@@ -92,7 +92,7 @@ static RageSurface *RageSurface_Load_PNG( RageFile *f, const char *fn, char erro
// Throwing an exception in the error callback would make the exception
// pass through C code, which is undefined behavior. Works fine on Linux,
// and on OS X with C++11, but does not work on OS X without C++11. -Kyz
// and on macOS with C++11, but does not work on macOS without C++11. -Kyz
if(setjmp(png_jmpbuf(png)))
{
png_destroy_read_struct(&png, &info_ptr, nullptr);
+1 -1
View File
@@ -44,7 +44,7 @@ RString SongCacheIndex::GetCacheFilePath( const RString &sGroup, const RString &
s = sPath;
/* Change slashes and invalid utf-8 characters to _.
* http://en.wikipedia.org/wiki/UTF-8
* Mac OS X doesn't support precomposed unicode characters in files names and
* macOS doesn't support precomposed unicode characters in files names and
* so we should probably replace them with combining diacritics.
* XXX How do we do this and is it even worth it? */
const char *invalid = "/\xc0\xc1\xfe\xff\xf8\xf9\xfa\xfb\xfc\xfd\xf5\xf6\xf7";
+1 -1
View File
@@ -1454,7 +1454,7 @@ bool HandleGlobalInputs( const InputEventPlus &input )
INPUTFILTER->IsBeingPressed(DeviceInput(DEVICE_KEYBOARD, KEY_LALT), &input.InputList)) )
{
// alt-enter
/* In OS X, this is a menu item and will be handled as such. This will
/* In macOS, this is a menu item and will be handled as such. This will
* happen first and then the lower priority GUI thread will happen second,
* causing the window to toggle twice. Another solution would be to put
* a timer in ArchHooks::SetToggleWindowed() and just not set the bool
+1 -1
View File
@@ -12,7 +12,7 @@ public:
virtual ~ArchHooks() { }
virtual void Init() { }
/*
* Return the general name of the architecture, eg. "Windows", "OS X", "Unix".
* Return the general name of the architecture, eg. "Windows", "macOS", "Unix".
*/
virtual RString GetArchName() const { return "generic"; }
+4 -6
View File
@@ -130,12 +130,10 @@ void ArchHooks_MacOSX::Init()
RString ArchHooks_MacOSX::GetArchName() const
{
#if defined(__i386__)
return "Mac OS X (i386)";
#elif defined(__x86_64__)
return "Mac OS X (x86_64)";
#if defined(__x86_64__)
return "macOS (x86_64)";
#elif defined(__aarch64__) || defined(__arm64__)
return "macOS (ARM64)";
return "macOS (arm64)";
#else
#error What arch?
#endif
@@ -149,7 +147,7 @@ void ArchHooks_MacOSX::DumpDebugInfo()
// http://stackoverflow.com/a/891336
NSDictionary *version = [NSDictionary dictionaryWithContentsOfFile:@"/System/Library/CoreServices/SystemVersion.plist"];
NSString *productVersion = [version objectForKey:@"ProductVersion"];
SystemVersion = ssprintf("Mac OS X %s", [productVersion cStringUsingEncoding:[NSString defaultCStringEncoding]]);
SystemVersion = ssprintf("macOS %s", [productVersion cStringUsingEncoding:[NSString defaultCStringEncoding]]);
}
size_t size;
@@ -124,12 +124,12 @@ TODO: Supply example Arduino/PIC/... firmware.
TODO: Supply example of full-duplex in cooperation with the SextetStream
lights driver.
### Mac OS X
### macOS
FIXME: *This has not been tested at all.* The following is a guess at a
synopsis of how it should work if you're lucky enough for everything to
have fallen into place just so. (Please amend this message if you manage
to get this running consistently on Mac OS X.)
to get this running consistently on macOS.)
Follow the instructions for Linux, but change the `InputDrivers` setting
to:
+3 -3
View File
@@ -74,14 +74,14 @@ TODO: Supply example Arduino/PIC/... firmware.
TODO: Supply example of full-duplex in cooperation with the SextetStream
input driver.
### Mac OS X
### macOS
FIXME: *This has not been tested at all.* The following is a guess at a
synopsis of how it should work if you're lucky enough for everything to
have fallen into place just so. (Please amend this message if you manage
to get this running consistently on Mac OS X.)
to get this running consistently on macOS.)
The instructions for Linux should work equally well for Mac OS X.
The instructions for Linux should work equally well for macOS.
TODO: Serial examples.
@@ -3,7 +3,7 @@
#include "LoadingWindow.h"
#include "global.h"
/** @brief Loading window for Mac OS X. */
/** @brief Loading window for macOS. */
class LoadingWindow_MacOSX : public LoadingWindow
{
public:
+1 -1
View File
@@ -457,7 +457,7 @@ bool SemaImpl_Pthreads::TryWait()
return true;
}
#else
// Use conditions, to work around OS X "forgetting" to implement semaphores.
// Use conditions, to work around macOS "forgetting" to implement semaphores.
SemaImpl_Pthreads::SemaImpl_Pthreads( int iInitialValue )
{
int ret = pthread_cond_init( &m_Cond, nullptr );
+1 -1
View File
@@ -673,7 +673,7 @@ void GetBacktrace( const void **buf, size_t size, const BacktraceContext *ctx )
{
ctx = &CurrentCtx;
/* __builtin_frame_address is broken on OS X; it sometimes returns bogus results. */
/* __builtin_frame_address is broken on macOS; it sometimes returns bogus results. */
register void *r1 __asm__ ("r1");
CurrentCtx.FramePtr = (const Frame *) r1;
CurrentCtx.PC = nullptr;
+1 -1
View File
@@ -7,7 +7,7 @@
#include <archutils/Darwin/VectorHelper.h>
#if 0
# error This depends on OS X and Apple's gcc.
# error This depends on macOS and Apple's gcc.
#endif
#ifndef USE_VEC
# error Enable altivec or sse.