[Localization] Sculptor #718

JavierMatosD · 2022-09-26T21:02:49Z

Localizes messages in the following files:

input.cpp
help.cpp

Thomas1664 · 2022-09-29T22:07:54Z

include/vcpkg/base/messages.h

+        "every dependency in the graph. For example, if no other constraints are specified (directly or "
+        "transitively), then the version will resolve to the baseline of the top level manifest. Baselines "
+        "of transitive dependencies are ignored.");
+    DECLARE_MESSAGE(BuiltInTriplets, (), "", "VCPKG built-in triplets:");


I remember that @ AugP opened a PR in the vcpkg repo to lowercase all occurrences of vcpkg in the documentation. We might want to do this here as well? (same below)

Interesting, I will have to ask him :)

include/vcpkg/base/messages.h

Thomas1664 · 2022-09-29T22:18:17Z

include/vcpkg/base/messages.h

+        UpdateBaselineHelp,
+        (),
+        "",
+        "To keep your libraries up to date, the best approach is to update your baseline reference. This will "


Suggested change

"To keep your libraries up to date, the best approach is to update your baseline reference. This will "

"The best approach to keep your libraries up to date is to update your baseline reference. This will "

I don't have a strong opinion on this one; just a style suggestion.

Thomas1664 · 2022-09-29T22:20:04Z

include/vcpkg/base/messages.h

+                    "Within the \"dependencies\" field, each dependency can have a minimum constraint listed. These "
+                    "minimum constraints will be used when transitively depending upon this library. A minimum "
+                    "port-version can additionally be specified with a '#' suffix.");
+    DECLARE_MESSAGE(VersionHelp, (), "", "A dot-separated sequence of numbers (1.2.3.4)");


Suggested change

DECLARE_MESSAGE(VersionHelp, (), "", "A dot-separated sequence of numbers (1.2.3.4)");

DECLARE_MESSAGE(VersionHelp, (), "", "A dot-separated sequence of non-negative numbers (1.2.3.4)");

just to clarify

The goal here is for this to fit within the width of a console together, I'm not sure this clarification is the right space/clarity tradeoff.

Thomas1664 · 2022-09-29T22:32:38Z

Hi @JavierMatosD,

You have several open localization PRs. I am curious weither there will be merge conflicts if one of them gets merged since your sorting might cause interference between your PRs.

JavierMatosD · 2022-10-05T00:21:56Z

Hi @JavierMatosD,

You have several open localization PRs. I am curious weither there will be merge conflicts if one of them gets merged since your sorting might cause interference between your PRs.

Hi @Thomas1664!

lol, yes, it causes merge conflicts. Admittedly, it is something I did not think about and is now coming back to bite me.

Thomas1664 · 2022-10-05T13:20:07Z

lol, yes, it causes merge conflicts. Admittedly, it is something I did not think about and is now coming back to bite me.

The way I would solve this in the future is to stop sorting and just put new messages at the end. Optionally you could alter between adding at the start vs. at the end. Then you only have to accept both changes. You can sort the messages when you're done with a Python script that splits at ; and sorts the resulting list.

# Conflicts: # include/vcpkg/base/messages.h # locales/messages.en.json # locales/messages.json # src/vcpkg/base/messages.cpp

BillyONeal

LGTM with nitpick fixes and replies for Thomas1664

BillyONeal · 2022-10-05T21:18:04Z

include/vcpkg/base/messages.h

@@ -580,6 +580,8 @@ namespace vcpkg
                    "An example of env_var is \"HTTP(S)_PROXY\""
                    "'--' at the beginning must be preserved",
                    "-- Automatically setting {env_var} environment variables to \"{url}\".");
+    DECLARE_MESSAGE(AvailableArchitectureTriplets, (), "", "Available architecture triplets");


Suggested change

DECLARE_MESSAGE(AvailableArchitectureTriplets, (), "", "Available architecture triplets");

DECLARE_MESSAGE(AvailableArchitectureTriplets, (), "", "Available architecture triplets:");

BillyONeal · 2022-10-05T21:19:57Z

src/vcpkg/help.cpp

-                   "transitively), then the version will resolve to the baseline of the top level manifest. Baselines "
-                   "of transitive dependencies are ignored.");
+        tbl.header(msg::format(msgManifestConstraints));
+        tbl.format("builtin-baseline", msg::format(msgBuiltinBaseHelp));


Does it make sense to name these so they sort together in messages.h (and to help translators realize they are related)?

BillyONeal · 2022-10-05T21:20:43Z

src/vcpkg/help.cpp

-        tbl.text("Each version additionally has a \"port-version\" which is a nonnegative integer. When rendered as "
-                 "text, the port version (if nonzero) is added as a suffix to the primary version text separated by a "
-                 "hash (#). Port-versions are sorted lexographically after the primary version text, for example:");
+        tbl.text(msg::format(msgPortVersionHelp));
        tbl.blank();
        tbl.blank();
        tbl.text("    1.0.0 < 1.0.0#1 < 1.0.1 < 1.0.1#5 < 2.0.0");


I think this part should be part of msgPortVersionHelp, even if it means the blank lines are removed.

BillyONeal · 2022-10-05T21:21:20Z

include/vcpkg/base/messages.h

@@ -1541,6 +1588,7 @@ namespace vcpkg
                    "",
                    "Unknown setting for VCPKG_BUILD_TYPE {option}. Valid settings are '', 'debug', and 'release'.");
    DECLARE_MESSAGE(UnknownTool, (), "", "vcpkg does not have a definition of this tool for this platform.");
+    DECLARE_MESSAGE(UnknownTopic, (msg::value), "{value} is a vcpkg topic", "unknown topic {value}");


Suggested change

DECLARE_MESSAGE(UnknownTopic, (msg::value), "{value} is a vcpkg topic", "unknown topic {value}");

DECLARE_MESSAGE(UnknownTopic, (msg::value), "{value} the value a user passed to `vcpkg help` that we don't understand", "unknown topic {value}");

BillyONeal · 2022-10-05T21:22:23Z

include/vcpkg/base/messages.h

@@ -1681,6 +1736,20 @@ namespace vcpkg
                    "",
                    "dependency {spec} was expected to be at least version "
                    "{expected_version}, but is currently {actual_version}.");
+    DECLARE_MESSAGE(VersionDateHelp, (), "", "A date (2021-01-01.5)");
+    DECLARE_MESSAGE(VersionFourFlavors, (), "", "Versions in vcpkg come in four primary flavors");


Should we change this to something like "the following versions are accepted" or similar so that the message need not be retranslated if/when the set changes?

BillyONeal · 2022-10-05T21:23:51Z

include/vcpkg/base/messages.h

+                    "Within the \"dependencies\" field, each dependency can have a minimum constraint listed. These "
+                    "minimum constraints will be used when transitively depending upon this library. A minimum "
+                    "port-version can additionally be specified with a '#' suffix.");
+    DECLARE_MESSAGE(VersionHelp, (), "", "A dot-separated sequence of numbers (1.2.3.4)");


The goal here is for this to fit within the width of a console together, I'm not sure this clarification is the right space/clarity tradeoff.

# Conflicts: # include/vcpkg/base/messages.h # locales/messages.en.json # locales/messages.json # src/vcpkg/base/messages.cpp

JavierMatosD added 3 commits September 26, 2022 13:13

localized messages in input.cpp

8926b01

localized messages in help.cpp

ed3245a

sorted messages

6efd3b0

JavierMatosD marked this pull request as ready for review September 28, 2022 17:13

Thomas1664 reviewed Sep 29, 2022

View reviewed changes

Merge remote-tracking branch 'origin/main' into Localization_Sculptor

5cb11e2

# Conflicts: # include/vcpkg/base/messages.h # locales/messages.en.json # locales/messages.json # src/vcpkg/base/messages.cpp

BillyONeal approved these changes Oct 5, 2022

View reviewed changes

JavierMatosD added 2 commits October 6, 2022 12:37

Response to feedback

6fc02da

Merge branch 'main' into Localization_Sculptor

5543daa

# Conflicts: # include/vcpkg/base/messages.h # locales/messages.en.json # locales/messages.json # src/vcpkg/base/messages.cpp

JavierMatosD merged commit 6386d3e into microsoft:main Oct 6, 2022

JavierMatosD deleted the Localization_Sculptor branch April 20, 2023 19:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Localization] Sculptor #718

[Localization] Sculptor #718

JavierMatosD commented Sep 26, 2022

Thomas1664 Sep 29, 2022 •

edited

Loading

JavierMatosD Oct 5, 2022

Thomas1664 Sep 29, 2022

Thomas1664 Sep 29, 2022

BillyONeal Oct 5, 2022

Thomas1664 commented Sep 29, 2022

JavierMatosD commented Oct 5, 2022

Thomas1664 commented Oct 5, 2022

BillyONeal left a comment

BillyONeal Oct 5, 2022

BillyONeal Oct 5, 2022

BillyONeal Oct 5, 2022

BillyONeal Oct 5, 2022

BillyONeal Oct 5, 2022

BillyONeal Oct 5, 2022

	"To keep your libraries up to date, the best approach is to update your baseline reference. This will "
	"The best approach to keep your libraries up to date is to update your baseline reference. This will "

	DECLARE_MESSAGE(VersionHelp, (), "", "A dot-separated sequence of numbers (1.2.3.4)");
	DECLARE_MESSAGE(VersionHelp, (), "", "A dot-separated sequence of non-negative numbers (1.2.3.4)");

	DECLARE_MESSAGE(AvailableArchitectureTriplets, (), "", "Available architecture triplets");
	DECLARE_MESSAGE(AvailableArchitectureTriplets, (), "", "Available architecture triplets:");

	DECLARE_MESSAGE(UnknownTopic, (msg::value), "{value} is a vcpkg topic", "unknown topic {value}");
	DECLARE_MESSAGE(UnknownTopic, (msg::value), "{value} the value a user passed to `vcpkg help` that we don't understand", "unknown topic {value}");

[Localization] Sculptor #718

[Localization] Sculptor #718

Conversation

JavierMatosD commented Sep 26, 2022

Thomas1664 Sep 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Thomas1664 commented Sep 29, 2022

JavierMatosD commented Oct 5, 2022

Thomas1664 commented Oct 5, 2022

BillyONeal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Thomas1664 Sep 29, 2022 •

edited

Loading