Improved documentation for --orientation option

inclement · inclement · commit fac0ee910e63 · 2017-01-14T20:20:58.000Z
diff --git a/doc/source/buildoptions.rst b/doc/source/buildoptions.rst
@@ -88,8 +88,12 @@ options (this list may not be exhaustive):
 - ``--package``: The Java package name for your project. Choose e.g. ``org.example.yourapp``.
 - ``--name``: The app name.
 - ``--version``: The version number.
-- ``--orientation``: One of ``portait``, ``landscape`` or ``sensor``
-  to automatically rotate according to the device orientation.
+- ``--orientation``: Usually one of ``portait``, ``landscape``,
+  ``sensor`` to automatically rotate according to the device
+  orientation, or ``user`` to do the same but obeying the user's
+  settings. The full list of valid options is given under
+  ``android:screenOrientation`` in the `Android documentation
+  <https://developer.android.com/guide/topics/manifest/activity-element.html>`__.
 - ``--icon``: A path to the png file to use as the application icon.
 - ``-- permission``: A permission name for the app,
   e.g. ``--permission VIBRATE``. For multiple permissions, add
@@ -144,8 +148,12 @@ ready.
 - ``--package``: The Java package name for your project. Choose e.g. ``org.example.yourapp``.
 - ``--name``: The app name.
 - ``--version``: The version number.
-- ``--orientation``: One of ``portait``, ``landscape`` or ``sensor``
-  to automatically rotate according to the device orientation.
+- ``--orientation``: Usually one of ``portait``, ``landscape``,
+  ``sensor`` to automatically rotate according to the device
+  orientation, or ``user`` to do the same but obeying the user's
+  settings. The full list of valid options is given under
+  ``android:screenOrientation`` in the `Android documentation
+  <https://developer.android.com/guide/topics/manifest/activity-element.html>`__.
 - ``--icon``: A path to the png file to use as the application icon.
 - ``-- permission``: A permission name for the app,
   e.g. ``--permission VIBRATE``. For multiple permissions, add
diff --git a/pythonforandroid/bootstraps/sdl2/build/build.py b/pythonforandroid/bootstraps/sdl2/build/build.py
@@ -412,8 +412,13 @@ def parse_args(args=None):
                     required=True)
     ap.add_argument('--orientation', dest='orientation', default='portrait',
                     help=('The orientation that the game will display in. '
-                          'Usually one of "landscape", "portrait" or '
-                          '"sensor"'))
+                          'Usually one of "landscape", "portrait", '
+                          '"sensor", or "user" (the same as "sensor" but '
+                          'obeying the user\'s Android rotation setting). '
+                          'The full list of options is given under '
+                          'android_screenOrientation at '
+                          'https://developer.android.com/guide/topics/manifest/'
+                          'activity-element.html'))
     ap.add_argument('--icon', dest='icon',
                     help='A png file to use as the icon for the application.')
     ap.add_argument('--permission', dest='permissions', action='append',
diff --git a/testapps/setup_testapp_python2.py b/testapps/setup_testapp_python2.py
@@ -9,6 +9,7 @@
                    'dist-name': 'bdisttest',
                    'ndk-version': '10.3.2',
                    'permission': 'VIBRATE',
+                   'window': None,
                    }}
 
 package_data = {'': ['*.py',
