[ios, macos] Rename the iOS and macOS SDKs #10610

jmkiley · 2017-12-01T01:10:35Z

Started the rename process (#10385) for iOS and macOS.

1ec5

platform/ios/DEVELOPING.md still has a reference to “the iOS SDK”. (Just be careful not to reword any references to Apple’s iOS SDK. 😉)

1ec5 · 2017-12-01T05:23:20Z

LICENSE.md

@@ -528,7 +528,7 @@ limitations under the License.

 ===========================================================================

-Mapbox GL uses portions of the Mapbox iOS SDK, which was derived from the
+Mapbox GL uses portions of the Mapbox Maps SDK for iOS, which was derived from the


This is a reference to the legacy Mapbox iOS SDK, which has not been renamed.

1ec5 · 2017-12-01T05:24:57Z

platform/ios/CHANGELOG.md

@@ -154,7 +154,7 @@ Mapbox welcomes participation and contributions from everyone. Please read [CONT
 ## 3.5.2 - April 7, 2017

 * Fixed an issue that caused a crash when the user location annotation was presenting a callout view and the map was moved. ([#8686](https://github.com/mapbox/mapbox-gl-native/pull/8686))
-* This release was built with Xcode 8.3.1, which fixed [a significant bitcode issue](http://www.openradar.me/31302382) introduced in Xcode 8.3 that caused Mapbox iOS SDK 3.5.1 to be 2× larger than 3.5.0.
+* This release was built with Xcode 8.3.1, which fixed [a significant bitcode issue](http://www.openradar.me/31302382) introduced in Xcode 8.3 that caused Mapbox Maps SDK for iOS 3.5.1 to be 2× larger than 3.5.0.


No need to rename references to previous versions of the SDK that were in fact named “Mapbox iOS SDK”. But while you’re here, can you add a blurb to the top of the changelog about the renaming? (Same for the macOS map SDK changelog.)

1ec5 · 2017-12-01T05:26:19Z

platform/ios/DEVELOPING.md

@@ -70,7 +70,7 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter

 1. Ensure that the symbol is pure Objective-C and does not rely on any language features specific to Objective-C++ or the C11 dialect of C – so no namespaced types or classes named with emoji! 🙃 Most projects that depend on this SDK are either written in pure Objective-C (GNU99 dialect) or Swift, which cannot yet bridge C++ types.
 1. Name the symbol according to [Cocoa naming conventions](https://developer.apple.com/library/prerelease/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html#//apple_ref/doc/uid/10000146i). Use the `MGL` class prefix to avoid conflicts with client code. If the symbol has an analogue in MapKit, name the symbol according to MapKit.
-1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the Mapbox iOS SDK website](https://www.mapbox.com/ios-sdk/api/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools.
+1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the Mapbox Maps SDK for iOS website](https://www.mapbox.com/ios-sdk/api/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools.


“On the Mapbox Maps SDK for iOS website” is a bit unwieldy. “On the website for this SDK” would be slightly more wieldy.

1ec5 · 2017-12-01T05:27:29Z

platform/ios/docs/pod-README.md

@@ -94,6 +94,6 @@ class ViewController: UIViewController {
 }
 ```

-Full API documentation is included in this package, within the `documentation` folder. For more details, read “[First steps with the Mapbox iOS SDK](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/).
+Full API documentation is included in this package, within the `documentation` folder. For more details, read “[First steps with the Mapbox Maps SDK for iOS](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/).


Heads-up that the URL to this guide will likely change as soon as it gets retitled to “First steps with the Mapbox Maps SDK for iOS”.

1ec5 · 2017-12-01T05:28:36Z

platform/macos/CHANGELOG.md

@@ -49,7 +49,7 @@

 ## 0.5.1

-This version of the Mapbox macOS SDK corresponds to version 3.6.4 of the Mapbox iOS SDK.
+This version of the Mapbox Maps SDK for macOS corresponds to version 3.6.4 of the Mapbox Maps SDK for iOS.


These and subsequent references are to older versions of the iOS and macOS map SDKs that were called “Mapbox iOS SDK” and “Mapbox macOS SDK” (or “Mapbox OS X SDK”), respectively.

1ec5 · 2017-12-01T05:34:37Z

platform/ios/src/MGLMapView.mm

@@ -1975,7 +1975,7 @@ - (void)trackGestureEvent:(NSString *)gestureID forRecognizer:(UIGestureRecogniz

 - (void)showAttribution:(__unused id)sender
 {
-    NSString *title = NSLocalizedStringWithDefaultValue(@"SDK_NAME", nil, nil, @"Mapbox iOS SDK", @"Action sheet title");
+    NSString *title = NSLocalizedStringWithDefaultValue(@"SDK_NAME", nil, nil, @"Mapbox Maps SDK for iOS", @"Action sheet title");


This change should be reflected in at least the base Localizable.strings file, if not all the translations as well.

Oops, thanks! I don't know why I didn't commit those.

jmkiley · 2017-12-01T17:47:41Z

Thanks @1ec5! I revised according to your feedback.

1ec5

Looks good. Just a reminder that there are a few stray references to “the iOS SDK” in the documentation that should become “the iOS map_^s SDK”: #10610 (review).

* changes in various markdown files * more tweaks * Updated attribution title

* mapbox_release5.2.1: (29 commits) [android] - update changelog for 5.2.1 release [ios, macos] Rename the iOS and macOS SDKs (mapbox#10610) [core, ios, qt, android] Close race condition in RunLoop (issue mapbox#9620) Because a message we queue from the foreground may cause the background to complete, exit, and tear down the AsyncTask, we have to block queue processing until we've finished our call to AsyncTask::send(). Broadening the scope of a mutex is scary, but I audited the code of our four implementations of AsyncTask and I don't see any way this could cause a deadlock. [android] - add FileSource activation/deactivation to MapSnapshotter, handle multiple deactivate scenario in FileSource (mapbox#10556) [android] - handle destroying activity programmatically as part of theme switching (mapbox#10589) [android] - use concurrent lists for camera change listeners (mapbox#10542) [android] - harden MarkerView integration by checking for null bitmap (mapbox#10532) [android] - activate filesource to list offline regions (mapbox#10531) [android] Enable map rendering when app is paused [ios, macos] Snapshot classes added to jazzy [android] remove unnecessary jar generation from gradle-publish.gradle (mapbox#10625) [ios, macos] Refactor snapshot attribution. [macos] Fixed logo view distortion on macOS High Sierra [ios, macos] Update changelogs. [ios, macos] Fix an issue that triggers didSelectAnnotations for MGLAnnotationImage based annotations. [ios] Fix minimumZoomLevel is not getting set. [android] - attribtuion anchor point calculation fix for short text with full logo on a MapSnapshot (mapbox#10558) [android] use location engine abstraction instead of location source (lost) in MyLocationView#init (mapbox#10579) [build] Added CircleCI macos-release-node{4,6} jobs [android] Set a larger limit for the HTTP dispatcher (mapbox#10567) ... # Conflicts: # platform/android/CHANGELOG.md # platform/android/MapboxGLAndroidSDK/gradle-publish.gradle # platform/android/MapboxGLAndroidSDK/gradle.properties

jmkiley added the documentation label Dec 1, 2017

jmkiley self-assigned this Dec 1, 2017

jmkiley requested review from friedbunny and 1ec5 December 1, 2017 01:10

1ec5 reviewed Dec 1, 2017

View reviewed changes

1ec5 approved these changes Dec 1, 2017

View reviewed changes

jmkiley and others added 15 commits December 4, 2017 12:50

[ios, macOS] initial .md changes

244090d

[ios, macos] More .md file changes

e2354e5

[ios] reset changelogs

5e55671

[ios, macos] reset some files back to master

122fc29

[ios, macos] a few more replacements

6b5a114

[ios, macos] renamed SDK in License.md

0f59234

[ios, macos] A few more changes

22ed007

[macos] stray revert

fbd47f2

[ios, macos] Addressed 1ec5's feedback

911c966

[build] Lint iOS and macOS plists on CI

72c99e1

Update gl-js submodule

e8da2d9

Android SDK renaming (#10609)

b115059

* changes in various markdown files * more tweaks * Updated attribution title

[ios, macos] iOS/macOS SDK -> iOS/macOS maps SDK

aaccf34

[ios] missed one iOS SDK

d4e1b7c

[ios] Missed one for macOS

e2fe871

jmkiley force-pushed the jmkiley-rename-sdk branch from 9e5f3e0 to e2fe871 Compare December 4, 2017 20:54

Merge branch 'master' into jmkiley-rename-sdk

a719d00

jmkiley merged commit 8f3cc3d into master Dec 5, 2017

jmkiley deleted the jmkiley-rename-sdk branch December 5, 2017 00:40

fabian-guerra pushed a commit that referenced this pull request Dec 5, 2017

[ios, macos] Rename the iOS and macOS SDKs (#10610)

a3a4242

fabian-guerra mentioned this pull request Dec 5, 2017

[ios, macos] Rename the iOS and macOS SDKs (#10610) #10640

Merged

fabian-guerra pushed a commit that referenced this pull request Dec 6, 2017

[ios, macos] Rename the iOS and macOS SDKs (#10610)

f89afa0

This was referenced Dec 16, 2017

Rename to Mapbox Maps SDK #10385

Closed

Rename Mapbox macOS SDK to Mapbox Maps SDK for macOS #10793

Merged

1ec5 mentioned this pull request Jan 5, 2018

Update iOS, macOS changelogs #10839

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ios, macos] Rename the iOS and macOS SDKs #10610

[ios, macos] Rename the iOS and macOS SDKs #10610

jmkiley commented Dec 1, 2017 •

edited

Loading

1ec5 left a comment

1ec5 Dec 1, 2017

1ec5 Dec 1, 2017

1ec5 Dec 1, 2017

1ec5 Dec 1, 2017

1ec5 Dec 1, 2017

1ec5 Dec 1, 2017

jmkiley Dec 1, 2017

jmkiley commented Dec 1, 2017

1ec5 left a comment

[ios, macos] Rename the iOS and macOS SDKs #10610

[ios, macos] Rename the iOS and macOS SDKs #10610

Conversation

jmkiley commented Dec 1, 2017 • edited Loading

1ec5 left a comment

Choose a reason for hiding this comment

1ec5 Dec 1, 2017

Choose a reason for hiding this comment

1ec5 Dec 1, 2017

Choose a reason for hiding this comment

1ec5 Dec 1, 2017

Choose a reason for hiding this comment

1ec5 Dec 1, 2017

Choose a reason for hiding this comment

1ec5 Dec 1, 2017

Choose a reason for hiding this comment

1ec5 Dec 1, 2017

Choose a reason for hiding this comment

jmkiley Dec 1, 2017

Choose a reason for hiding this comment

jmkiley commented Dec 1, 2017

1ec5 left a comment

Choose a reason for hiding this comment

jmkiley commented Dec 1, 2017 •

edited

Loading