From 95069d8f789e3819064ffa03b6bff697c37f547f Mon Sep 17 00:00:00 2001 From: Gerald Combs Date: Sun, 7 Aug 2022 12:21:26 -0700 Subject: [PATCH] Docs: Clean up some Python references. Make sure we captitalize Python and use its HTTPS URL. --- doc/README.idl2wrs | 2 +- doc/extcap.adoc | 7 ++----- doc/extcap_example.py | 4 ++-- docbook/wsdg_src/WSDG_chapter_tests.adoc | 2 +- docbook/wsdg_src/WSDG_chapter_tools.adoc | 7 ++++--- 5 files changed, 10 insertions(+), 12 deletions(-) diff --git a/doc/README.idl2wrs b/doc/README.idl2wrs index 6337cfa8bf..77596cb339 100644 --- a/doc/README.idl2wrs +++ b/doc/README.idl2wrs @@ -46,7 +46,7 @@ need the following. 1. Python must be installed - http://python.org/ + https://python.org/ 2. omniidl from the omniORB package must be available. http://omniorb.sourceforge.net/ diff --git a/doc/extcap.adoc b/doc/extcap.adoc index 1f79568c99..d64a9edab4 100644 --- a/doc/extcap.adoc +++ b/doc/extcap.adoc @@ -36,11 +36,8 @@ WINDOWS USERS: Because of restrictions directly calling the script may not alway In such a case, a batch file may be provided, which then in turn executes the script. Please refer to doc/extcap_example.py for more information. -When Wireshark launches an extcap, it automatically adds its installation path -(c:\Program Files\Wireshark\) to the DLL search path so that the extcap library dependencies -can be found (it is not designed to be launched by hand). This is done on purpose. There should -only be extcap programs (executable, python scripts, ...) in the extcap folder to reduce the startup -time and not have Wireshark trying to execute other file types. +When Wireshark launches an extcap, it automatically adds its installation path (normally _C:\Program Files\Wireshark\_) to the DLL search path so that the extcap library dependencies can be found (it is not designed to be launched by hand). +This is done on purpose. There should only be extcap programs (executables, Python scripts, ...) in the extcap folder to reduce the startup time and not have Wireshark trying to execute other file types. == GRAMMAR ELEMENTS diff --git a/doc/extcap_example.py b/doc/extcap_example.py index 14e792b25c..26e39e3509 100755 --- a/doc/extcap_example.py +++ b/doc/extcap_example.py @@ -20,7 +20,7 @@ the extcap folder, with the following content: ------- @echo off - %* +C:\Windows\py.exe C:\Path\to\extcap_example.py %* ------- Windows is not able to execute Python scripts directly, which also goes for all @@ -445,7 +445,7 @@ if __name__ == '__main__': parser = ArgumentParser( prog="Extcap Example", - description="Extcap example program for python" + description="Extcap example program for Python" ) # Extcap Arguments diff --git a/docbook/wsdg_src/WSDG_chapter_tests.adoc b/docbook/wsdg_src/WSDG_chapter_tests.adoc index fdf9e31853..6d7ba3cc2d 100644 --- a/docbook/wsdg_src/WSDG_chapter_tests.adoc +++ b/docbook/wsdg_src/WSDG_chapter_tests.adoc @@ -68,7 +68,7 @@ be skipped while other tests can still run to completion. The `test/test.py` script uses Python's “unittest” module. Our tests are patterned after it, and individual tests are organized according to -suites, cases, and individual tests. Suites correspond to python modules +suites, cases, and individual tests. Suites correspond to Python modules that match the pattern “suite_*.py”. Cases correspond to one or more classes in each module, and case class methods matching the pattern ”test_*” correspond to individual tests. For example, the invalid diff --git a/docbook/wsdg_src/WSDG_chapter_tools.adoc b/docbook/wsdg_src/WSDG_chapter_tools.adoc index c7225ed8e5..e84f5c8efb 100644 --- a/docbook/wsdg_src/WSDG_chapter_tools.adoc +++ b/docbook/wsdg_src/WSDG_chapter_tools.adoc @@ -655,9 +655,10 @@ Your version string will likely vary. === Python -https://python.org/[Python] is an interpreted programming language. It is -used to generate some source files, documentation, testing and other tasks. -Python 3.4 and later is required. Python 2.7 is no longer supported. +https://python.org/[Python] is an interpreted programming language. +It is used to generate some source files, documentation, testing and other tasks. +Python 3.6 and later is required. +Python 2 is no longer supported. Python is either included or available as a package on most UNIX-like platforms. Windows packages and source are available at https://python.org/download/[].