1201102 - export-locales.sh produces warnings causing missing strings

Status: RESOLVED WONTFIX

(Firefox for iOS :: Build & Test, defect)

Description

[Stephan Leroux [:sleroux]]

When running the export-locales.sh script, we're getting a bunch of warnings:

Warning: Key "Bookmark" used with multiple comments "Accessibility Label for the browser toolbar Bookmark button" & "Bookmark a URL - https://bugzilla.mozilla.org/attachment.cgi?id=8624438, https://bug1157303.bugzilla.mozilla.org/attachment.cgi?id=8624440"
Warning: Key "Cancel" used with multiple comments "Alert Cancel Button" & "Authentication prompt cancel button" & "Button label to cancel entering a URL or search query" & "Cancel alert view" & "Cancel button" & "Cancel button in the 'log out firefox account' alert" & "Cancel title from search engine picker"
Warning: Key "Default Search Engine" used with multiple comments "Accessibility label for default search engine setting." & "Title for default search engine picker." & "Title for default search engine settings section."
Warning: Key "Done" used with multiple comments "Done button label for search settings table" & "Done button label on back forward list screen" & "Done button on left side of the Settings view controller title bar" & "Done editing button"
Warning: Key "Log Out" used with multiple comments "Button in settings screen to disconnect from your account" & "Disconnect button in the 'log out firefox account' alert"
Warning: Key "Mark as Read" used with multiple comments "Name for Mark as read button in reader mode" & "Title for the button that marks a reading list item as read"
Warning: Key "Mark as Unread" used with multiple comments "Name for Mark as unread button in reader mode" & "Title for the button that marks a reading list item as unread"
Warning: Key "OK" used with multiple comments "Alert OK Button" & "Label for OK button in the application update prompt" & "OK button"
Warning: Key "Search" used with multiple comments "Navigation title for search settings." & "Open search section of settings"
Warning: Key "Settings" used with multiple comments "Accessibility label for the Settings button in the Tab Tray." & "Settings"
Warning: Key "Show Tabs" used with multiple comments "Accessibility label for the tabs button in the (top) browser toolbar" & "Accessibility Label for the tabs button in the browser toolbar"
Warning: Key "Sign in" used with multiple comments "Button that leads to Sign in section of the Settings sheet." & "See http://mzl.la/1Qtkf0j" & "Text message / button in the settings table view"
/Warning: Key "Untitled" used with multiple comments "The default name for bookmark folders without titles." & "The default name for bookmark nodes without titles."
Warning: Key "Untitled" used with multiple comments "The default name for bookmark folders without titles." & "The default name for bookmark nodes without titles."
Warning: Key "Add to Reading List" used with multiple comments "Accessibility label for action adding current page to reading list." & "Add URL to the reading list - https://bugzilla.mozilla.org/attachment.cgi?id=8624438, https://bug1157303.bugzilla.mozilla.org/attachment.cgi?id=8624440" & "Name for button adding current article to reading list in reader mode"
Warning: Key "Bookmark" used with multiple comments "Accessibility Label for the browser toolbar Bookmark button" & "Bookmark a URL - https://bugzilla.mozilla.org/attachment.cgi?id=8624438, https://bug1157303.bugzilla.mozilla.org/attachment.cgi?id=8624440"
Warning: Key "Cancel" used with multiple comments "Alert Cancel Button" & "Authentication prompt cancel button" & "Button label to cancel entering a URL or search query" & "Cancel alert view" & "Cancel button" & "Cancel button in the 'log out firefox account' alert" & "Cancel title from search engine picker"
Warning: Key "Default Search Engine" used with multiple comments "Accessibility label for default search engine setting." & "Title for default search engine picker." & "Title for default search engine settings section."
Warning: Key "Done" used with multiple comments "Done button label for search settings table" & "Done button label on back forward list screen" & "Done button on left side of the Settings view controller title bar" & "Done editing button"
Warning: Key "Log Out" used with multiple comments "Button in settings screen to disconnect from your account" & "Disconnect button in the 'log out firefox account' alert"
Warning: Key "Mark as Read" used with multiple comments "Name for Mark as read button in reader mode" & "Title for the button that marks a reading list item as read"
Warning: Key "Mark as Unread" used with multiple comments "Name for Mark as unread button in reader mode" & "Title for the button that marks a reading list item as unread"
Warning: Key "OK" used with multiple comments "Alert OK Button" & "Label for OK button in the application update prompt" & "OK button"
Warning: Key "Search" used with multiple comments "Navigation title for search settings." & "Open search section of settings"
Warning: Key "Settings" used with multiple comments "Accessibility label for the Settings button in the Tab Tray." & "Settings"
Warning: Key "Show Tabs" used with multiple comments "Accessibility label for the tabs button in the (top) browser toolbar" & "Accessibility Label for the tabs button in the browser toolbar"
Warning: Key "Sign in" used with multiple comments "Button that leads to Sign in section of the Settings sheet." & "See http://mzl.la/1Qtkf0j" & "Text message / button in the settings table view"
Warning: Key "Untitled" used with multiple comments "The default name for bookmark folders without titles." & "The default name for bookmark nodes without titles."
Warning: Key "Untitled" used with multiple comments "The default name for bookmark folders without titles." & "The default name for bookmark nodes without titles."

It looks like for each of these collisions, only the first string is added to the .xliff and the other does not. From some of the strings I've seen this is likely caused by us not specifying a tableName whenever we wrap the strings using the NSLocalizedName macro.

Comment 1

[Stephan Leroux [:sleroux]]

:st3fan have you seen this before?

Comment 2

[Stefan Arentz | :st3fan | ⏰ EST | he/him]

I don't think any data goes missing. For example, this is how Cancel is exported:

      <trans-unit id="Cancel">
        <source>Cancel</source>
        <target>Annuleren</target>
        <note>Alert Cancel Button
   Authentication prompt cancel button
   Button label to cancel entering a URL or search query
   Cancel alert view
   Cancel button
   Cancel button in the 'log out firefox account' alert</note>
      </trans-unit>

The multiple comments are put together in the notes field in the XLIFF.

Needinfo :flod to find out if this really is something we need to address.

Comment 3

[Stefan Plewako [:stef]]

So where comments like "Cancel title from search engine picker" go?
https://github.com/mozilla/firefox-ios/blob/master/Client/Frontend/Settings/SearchEnginePicker.swift#L20
(see also bug 1196949)

Comment 4

[Francesco Lodolo [:flod]]

(passing by, still on PTO until next Monday)

That's export-locales.sh, but just as a side effect. Those warnings come from xcodebuild
https://github.com/mozilla/firefox-ios/blob/master/scripts/export-locales.sh#L37

I don't think comments are lost, they're added to the same string. The only strange one is "Cancel", if I export now I get only the last comment ("Cancel title from search engine picker"), instead of all the previous ones.

Comment 5

[Richard Newman [:rnewman]]

Tool is stupid.

Comment 6

[Stefan Plewako [:stef]]

(In reply to Richard Newman [:rnewman] from comment #5)
> Tool is stupid.

Don't know what exactly "Tool is stupid." means but I'm reopening as per bug 1196949 comment 14.