[Scummvm-git-logs] scummvm branch-2-7 -> 9191d96fbbf44667d9d45eb76c95cc198cdfbbc7

[sev-]

This automated email contains information about 3 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
5394c9d155 DOCS: adds autostart page
e6fcfd6b33 DOCS: Fix command line parameter for autodetection
9191d96fbb DOCS: Clarify autostart documentation


Commit: 5394c9d155d4a3651ab7f96c9b5487a3ef5dffb8
    https://github.com/scummvm/scummvm/commit/5394c9d155d4a3651ab7f96c9b5487a3ef5dffb8
Author: CadiH (cadihowley at gmail.com)
Date: 2023-03-03T21:44:19+01:00

Commit Message:
DOCS: adds autostart page

Changed paths:
  A doc/docportal/advanced_topics/autostart.rst
    doc/docportal/index.rst


diff --git a/doc/docportal/advanced_topics/autostart.rst b/doc/docportal/advanced_topics/autostart.rst
new file mode 100644
index 00000000000..b1d8435046a
--- /dev/null
+++ b/doc/docportal/advanced_topics/autostart.rst
@@ -0,0 +1,22 @@
+=========================
+Autostart
+=========================
+
+Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-run`` :doc:`command line options <../advanced_topics/command_line>`. 
+
+There are two ways to use the autostart feature:
+
+- Rename the executable file to ``scummvm-auto.xxx``, where ``xxx`` is the file type extension. 
+- Create an empty file named ``scummvm-autorun`` in the same folder as both the executable and the chosen game. Either leave the file empty, or use it to specify any further command line options. Specify one option per line. 
+
+Example of a scummvm-autorun file
+===================================
+
+.. code::
+
+    --fullscreen
+    --shader=crt/crt-lottes.glslp
+
+    
+
+
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index 97bdd17e7f8..7d2cff8a0f1 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -52,11 +52,13 @@
       :glob:
       :hidden:
 
+      advanced_topics/autostart
       advanced_topics/command_line
       advanced_topics/configuration_file
       advanced_topics/understand_audio
       advanced_topics/understand_graphics
       advanced_topics/understand_search_box
+      
 
 .. toctree::
       :caption: Help
@@ -198,6 +200,9 @@ In this section, we also take a deep dive into understanding the graphics and au
 
       Advanced features
       ^^^^^^^^^^^^^^^^^^^^
+      
+      :doc:`advanced_topics/autostart`
+      
       :doc:`advanced_topics/configuration_file`
 
       :doc:`advanced_topics/command_line`
@@ -211,6 +216,8 @@ In this section, we also take a deep dive into understanding the graphics and au
 
       :doc:`The graphics settings <advanced_topics/understand_graphics>`
 
+      :doc:`The search box <advanced_topics/understand_search_box>`
+
 
 
 Getting help


Commit: e6fcfd6b337fc750e49149a400fe37a321c31e6e
    https://github.com/scummvm/scummvm/commit/e6fcfd6b337fc750e49149a400fe37a321c31e6e
Author: Eugene Sandulenko (sev at scummvm.org)
Date: 2023-03-03T21:44:29+01:00

Commit Message:
DOCS: Fix command line parameter for autodetection

Co-authored-by: Thierry Crozat <criezy at scummvm.org>

Changed paths:
    doc/docportal/advanced_topics/autostart.rst


diff --git a/doc/docportal/advanced_topics/autostart.rst b/doc/docportal/advanced_topics/autostart.rst
index b1d8435046a..7301bd797aa 100644
--- a/doc/docportal/advanced_topics/autostart.rst
+++ b/doc/docportal/advanced_topics/autostart.rst
@@ -2,7 +2,7 @@
 Autostart
 =========================
 
-Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-run`` :doc:`command line options <../advanced_topics/command_line>`. 
+Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-detect`` :doc:`command line options <../advanced_topics/command_line>`. 
 
 There are two ways to use the autostart feature:
 


Commit: 9191d96fbbf44667d9d45eb76c95cc198cdfbbc7
    https://github.com/scummvm/scummvm/commit/9191d96fbbf44667d9d45eb76c95cc198cdfbbc7
Author: Eugene Sandulenko (sev at scummvm.org)
Date: 2023-03-03T21:44:43+01:00

Commit Message:
DOCS: Clarify autostart documentation

Changed paths:
    doc/docportal/advanced_topics/autostart.rst


diff --git a/doc/docportal/advanced_topics/autostart.rst b/doc/docportal/advanced_topics/autostart.rst
index 7301bd797aa..f66eb43deab 100644
--- a/doc/docportal/advanced_topics/autostart.rst
+++ b/doc/docportal/advanced_topics/autostart.rst
@@ -2,12 +2,12 @@
 Autostart
 =========================
 
-Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-detect`` :doc:`command line options <../advanced_topics/command_line>`. 
+Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-detect`` :doc:`command line options <../advanced_topics/command_line>`.
 
 There are two ways to use the autostart feature:
 
-- Rename the executable file to ``scummvm-auto.xxx``, where ``xxx`` is the file type extension. 
-- Create an empty file named ``scummvm-autorun`` in the same folder as both the executable and the chosen game. Either leave the file empty, or use it to specify any further command line options. Specify one option per line. 
+- Rename the executable file to ``scummvm-auto.xxx``, where ``.xxx`` is the file type extension (if applicable). On macOS the executable to rename is ``ScummVM.app/Contents/MacOS/scummvm`` and not the ``ScummVM.app`` application.
+- Create an empty file named ``scummvm-autorun`` in the same folder as both the executable and the chosen game. Either leave the file empty, or use it to specify any further command line options. Specify one option per line.
 
 Example of a scummvm-autorun file
 ===================================
@@ -16,7 +16,5 @@ Example of a scummvm-autorun file
 
     --fullscreen
     --shader=crt/crt-lottes.glslp
-
-    
-
-
+    --path=./game/
+    --auto-detect