Docs: Rename the release notes

Rename the Wireshark release notes source file to "Wireshark_Release_Notes".

This is in preparation for adding the Stratoshark release notes and a
captitalized name with spaces looks nicer in the system's file explorer.

.gitignore

@@ -86,9 +86,10 @@ doc/user-guide*.xml
 doc/*-guide-*.pdf
 doc/ws?g_html/
 doc/ws?g_html_chunked/
-doc/release-notes-*.pdf
-doc/release-notes.html
-doc/release-notes.txt
+doc/Wireshark Release Notes.html
+doc/Wireshark Release Notes.txt
+doc/Stratoshark Release Notes.html
+doc/Stratoshark Release Notes.txt
 doc/wsluarm
 doc/wsluarm_src/
 wsar_html/

.gitlab-ci.yml

@@ -290,8 +290,10 @@ Source Package:
     - cd build
     - ninja release_notes
     - WIRESHARK_VERSION=$(< wireshark_version.txt)
-    - cp -v doc/release-notes.html ../release-notes-${WIRESHARK_VERSION}.html
-    - cp -v doc/release-notes.txt ../release-notes-${WIRESHARK_VERSION}.txt
+    - cp -v "doc/Wireshark Release Notes.html" ../wireshark-release-notes-${WIRESHARK_VERSION}.html
+    - cp -v "doc/Wireshark Release Notes.txt" ../wireshark-release-notes-${WIRESHARK_VERSION}.txt
+    # - cp -v "doc/Stratoshark Release Notes.html" ../stratoshark-release-notes-${STRATOSHARK_VERSION}.html
+    # - cp -v "doc/Stratoshark Release Notes.txt" ../stratoshark-release-notes-${STRATOSHARK_VERSION}.txt
     - cd ..
     - zstdcat --threads=0 wireshark-${WIRESHARK_VERSION}.tar.zst | xz --threads=0 > wireshark-${WIRESHARK_VERSION}.tar.xz
   after_script:
@@ -301,12 +303,14 @@ Source Package:
     - stat --format="%n %s bytes" wireshark-*.tar.*
     - for digest in sha512 sha256 sha1 ; do openssl $digest wireshark-*.tar.* ; done
     - if [ -n "$MC_DESTINATION_DIST" ] ; then mc --quiet cp wireshark-*.tar.* "$MC_DESTINATION_DIST/" ; fi
-    - if [ -n "$MC_DESTINATION_RELEASE" ] ; then mc --quiet cp release-notes-*.{txt,html} "$MC_DESTINATION_RELEASE/" ; fi
+    - if [ -n "$MC_DESTINATION_RELEASE" ] ; then mc --quiet cp {wire,strato}shark-release-notes-*.{txt,html} "$MC_DESTINATION_RELEASE/" ; fi
   artifacts:
     paths:
       - wireshark-*.tar.*
-      - release-notes-*.html
-      - release-notes-*.txt
+      - wireshark-release-notes-*.html
+      - wireshark-release-notes-*.txt
+      - stratoshark-release-notes-*.html
+      - stratoshark-release-notes-*.txt
 
 # Job to generate packages for Debian stable
 Debian Stable APT Package:
@@ -520,12 +524,12 @@ Windows x64 Package:
     - $nsisSha256 = (Get-FileHash -Algorithm SHA256 .\packaging\nsis\Wireshark-*-x64.exe).Hash
     - $wiresharkVersion = Get-Content .\wireshark_version.txt
     - $stratosharkVersion = Get-Content .\stratoshark_version.txt
-    - Set-Content -Path release-info-$($wiresharkVersion)-windows-x64.ini -Value ("[DEFAULT]`nnsis_sha256 = $nsisSha256")
-    - if (Test-Path env:MC_DESTINATION_RELEASE) { C:\gitlab-builds\bin\mc --quiet cp release-info-$($wiresharkVersion)-windows-x64.ini "$env:MC_DESTINATION_RELEASE/" }
+    - Set-Content -Path wireshark-release-info-$($wiresharkVersion)-windows-x64.ini -Value ("[DEFAULT]`nnsis_sha256 = $nsisSha256")
+    - if (Test-Path env:MC_DESTINATION_RELEASE) { C:\gitlab-builds\bin\mc --quiet cp wireshark-release-info-$($wiresharkVersion)-windows-x64.ini "$env:MC_DESTINATION_RELEASE/" }
     - C:\Windows\py.exe -m pytest
   artifacts:
     paths:
-      - build/release-info-*.ini
+      - build/wireshark-release-info-*.ini
 
 Windows Arm64 Package:
   extends: .build-windows
@@ -560,12 +564,12 @@ Windows Arm64 Package:
     - $nsisSha256 = (Get-FileHash -Algorithm SHA256 .\packaging\nsis\Wireshark-*-arm64.exe).Hash
     - $wiresharkVersion = Get-Content .\wireshark_version.txt
     - $stratosharkVersion = Get-Content .\stratoshark_version.txt
-    - Set-Content -Path release-info-$($wiresharkVersion)-windows-arm64.ini -Value ("[DEFAULT]`nnsis_sha256 = $nsisSha256")
-    - if (Test-Path env:MC_DESTINATION_RELEASE) { C:\gitlab-builds\bin\mc --quiet cp release-info-$($wiresharkVersion)-windows-arm64.ini "$env:MC_DESTINATION_RELEASE/" }
+    - Set-Content -Path wireshark-release-info-$($wiresharkVersion)-windows-arm64.ini -Value ("[DEFAULT]`nnsis_sha256 = $nsisSha256")
+    - if (Test-Path env:MC_DESTINATION_RELEASE) { C:\gitlab-builds\bin\mc --quiet cp wireshark-release-info-$($wiresharkVersion)-windows-arm64.ini "$env:MC_DESTINATION_RELEASE/" }
     - C:\Windows\py.exe -m pytest
   artifacts:
     paths:
-      - build/release-info-*.ini
+      - build/wireshark-release-info-*.ini
 
 Windows MinGW-w64 Package:
   extends: .build-mingw
@@ -625,13 +629,13 @@ macOS Arm Package:
     - DMG_SHA256=$( shasum --algorithm 256 Wireshark?[1-9]*.dmg | awk '{print $1}' )
     - WIRESHARK_VERSION=$(< ../wireshark_version.txt)
     - STRATOSHARK_VERSION=$(< ../stratoshark_version.txt)
-    - printf '[DEFAULT]\nsparkle_signature = %s\ndmg_sha256 = %s\n' "$SPARKLE_SIGNATURE" "$DMG_SHA256" > release-info-${WIRESHARK_VERSION}-macos-arm64.ini
-    - if [[ -n "$S3_DESTINATION_RELEASE" ]] ; then aws s3 cp release-info-${WIRESHARK_VERSION}-macos-arm64.ini "$S3_DESTINATION_RELEASE/" ; fi
+    - printf '[DEFAULT]\nsparkle_signature = %s\ndmg_sha256 = %s\n' "$SPARKLE_SIGNATURE" "$DMG_SHA256" > wireshark-release-info-${WIRESHARK_VERSION}-macos-arm64.ini
+    - if [[ -n "$S3_DESTINATION_RELEASE" ]] ; then aws s3 cp wireshark-release-info-${WIRESHARK_VERSION}-macos-arm64.ini "$S3_DESTINATION_RELEASE/" ; fi
     - cd ..
     - ninja test
   artifacts:
     paths:
-      - build/run/release-info-*.ini
+      - build/run/wireshark-release-info-*.ini
   needs: []
 
 macOS Intel Package:
@@ -678,13 +682,13 @@ macOS Intel Package:
     - DMG_SHA256=$( shasum --algorithm 256 Wireshark?[1-9]*.dmg | awk '{print $1}' )
     - WIRESHARK_VERSION=$(< ../wireshark_version.txt)
     - STRATOSHARK_VERSION=$(< ../stratoshark_version.txt)
-    - printf '[DEFAULT]\nsparkle_signature = %s\ndmg_sha256 = %s\n' "$SPARKLE_SIGNATURE" "$DMG_SHA256" > release-info-${WIRESHARK_VERSION}-macos-intel64.ini
-    - if [[ -n "$S3_DESTINATION_RELEASE" ]] ; then aws s3 cp release-info-${WIRESHARK_VERSION}-macos-intel64.ini "$S3_DESTINATION_RELEASE/" ; fi
+    - printf '[DEFAULT]\nsparkle_signature = %s\ndmg_sha256 = %s\n' "$SPARKLE_SIGNATURE" "$DMG_SHA256" > wireshark-release-info-${WIRESHARK_VERSION}-macos-intel64.ini
+    - if [[ -n "$S3_DESTINATION_RELEASE" ]] ; then aws s3 cp wireshark-release-info-${WIRESHARK_VERSION}-macos-intel64.ini "$S3_DESTINATION_RELEASE/" ; fi
     - cd ..
     - ninja test
   artifacts:
     paths:
-      - build/run/release-info-*.ini
+      - build/run/wireshark-release-info-*.ini
   needs: []
 
 # Build the User's Guide and Developer's Guide

CMakeLists.txt

@@ -2264,7 +2264,8 @@ if (ASCIIDOCTOR_FOUND)
 		${CMAKE_BINARY_DIR}/doc/man_pages/tshark.html
 		${CMAKE_BINARY_DIR}/doc/man_pages/wireshark.html
 		${CMAKE_BINARY_DIR}/doc/man_pages/wireshark-filter.html
-		${CMAKE_BINARY_DIR}/doc/release-notes.html
+		"${CMAKE_BINARY_DIR}/doc/Wireshark Release Notes.html"
+		# "${CMAKE_BINARY_DIR}/doc/Stratoshark Release Notes.html"
 	)
 	if(MAXMINDDB_FOUND)
 		list(APPEND DOC_FILES ${CMAKE_BINARY_DIR}/doc/man_pages/mmdbresolve.html)

doc/CMakeLists.txt

@@ -108,18 +108,22 @@ if(ASCIIDOCTOR_FOUND)
 endif()
 
 if(ASCIIDOCTOR_FOUND)
-	ASCIIDOCTOR2HTML(release-notes.adoc)
-	ASCIIDOCTOR2TXT(release-notes.adoc)
+	ASCIIDOCTOR2HTML("Wireshark_Release_Notes.adoc" CONVERT_UNDERSCORES)
+	ASCIIDOCTOR2TXT("Wireshark_Release_Notes.adoc" CONVERT_UNDERSCORES)
+	# ASCIIDOCTOR2HTML("Stratoshark Release Notes.adoc" CONVERT_UNDERSCORES)
+	# ASCIIDOCTOR2TXT("Stratoshark Release Notes.adoc" CONVERT_UNDERSCORES)
 
 	add_custom_target(release_notes_html
 		DEPENDS
-			${CMAKE_CURRENT_BINARY_DIR}/release-notes.html
+			"${CMAKE_CURRENT_BINARY_DIR}/Wireshark Release Notes.html"
+			# "${CMAKE_CURRENT_BINARY_DIR}/Stratoshark Release Notes.html"
 	)
 	set_target_properties(release_notes_html PROPERTIES FOLDER "Documentation")
 
 	add_custom_target(release_notes_txt
 		DEPENDS
-			${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
+			"${CMAKE_CURRENT_BINARY_DIR}/Wireshark Release Notes.txt"
+			# "${CMAKE_CURRENT_BINARY_DIR}/Stratoshark Release Notes.txt"
 			release_notes_html
 	)
 	set_target_properties(release_notes_txt PROPERTIES FOLDER "Documentation")
@@ -160,7 +164,8 @@ if(ASCIIDOCTOR_FOUND)
 	install(
 		FILES
 			${HTML_INSTALL_FILES}
-			${CMAKE_CURRENT_BINARY_DIR}/release-notes.html
+			"${CMAKE_CURRENT_BINARY_DIR}/Wireshark Release Notes.html"
+			# "${CMAKE_CURRENT_BINARY_DIR}/Stratoshark Release Notes.html"
 		DESTINATION
 			${CMAKE_INSTALL_DOCDIR}
 		COMPONENT "ReleaseNotes"

doc/wsdg_src/wsdg_sources.adoc

@@ -1053,8 +1053,8 @@ $ git cherry-pick -x 1ab2c3d4
 $ ninja
 $ ...
 
-# OPTIONAL: Add entries to doc/release-notes.adoc.
-$EDITOR doc/release-notes.adoc
+# OPTIONAL: Add entries to doc/Wireshark_Release_Notes.adoc.
+$EDITOR "doc/Wireshark_Release_Notes.adoc"
 
 # If you made any changes, update your commit.
 git commit --amend -a

packaging/nsis/stratoshark.nsi

@@ -1186,7 +1186,7 @@ Delete "$INSTDIR\browser_sslkeylog.lua"
 Delete "$INSTDIR\console.lua"
 Delete "$INSTDIR\dtd_gen.lua"
 Delete "$INSTDIR\init.lua"
-Delete "$INSTDIR\release-notes.html"
+Delete "$INSTDIR\Stratoshark Release Notes.html"
 
 RMDir "$INSTDIR\accessible"
 RMDir "$INSTDIR\audio"

packaging/nsis/wireshark.nsi

@@ -74,7 +74,7 @@ BrandingText "Wireshark${U+00ae} Installer"
 ; is usually not associated with an appropriate text editor. We should use extension "txt"
 ; for a text file or "html" for an html README file.
 !define MUI_FINISHPAGE_TITLE_3LINES
-!define MUI_FINISHPAGE_SHOWREADME "$INSTDIR\release-notes.html"
+!define MUI_FINISHPAGE_SHOWREADME "$INSTDIR\Wireshark Release Notes.html"
 !define MUI_FINISHPAGE_SHOWREADME_TEXT "Open the release notes"
 !define MUI_FINISHPAGE_SHOWREADME_NOTCHECKED
 ; NSIS runs as Administrator and will run Wireshark as Administrator
@@ -547,7 +547,7 @@ File "${STAGING_DIR}\dumpcap.exe"
 File "${STAGING_DIR}\dumpcap.html"
 File "${STAGING_DIR}\extcap.html"
 File "${STAGING_DIR}\ipmap.html"
-File "${STAGING_DIR}\release-notes.html"
+File "${STAGING_DIR}\Wireshark Release Notes.html"
 
 !ifdef USE_VCREDIST
 ; C-runtime redistributable
@@ -1428,6 +1428,7 @@ Delete "$INSTDIR\console.lua"
 Delete "$INSTDIR\dtd_gen.lua"
 Delete "$INSTDIR\init.lua"
 Delete "$INSTDIR\release-notes.html"
+Delete "$INSTDIR\Wireshark Release Notes.html"
 
 RMDir "$INSTDIR\accessible"
 RMDir "$INSTDIR\audio"

packaging/wix/ComponentGroups.wxi

@@ -61,7 +61,7 @@
           <File Id="filIpmap_html" KeyPath="yes" Source="$(var.Staging.Dir)\ipmap.html" />
         </Component>
         <Component Id="cmpReleaseNotes_html" Guid="*">
-          <File Id="filReleaseNotes_html" KeyPath="yes" Source="$(var.Staging.Dir)\release-notes.html" />
+          <File Id="filReleaseNotes_html" KeyPath="yes" Source="$(var.Staging.Dir)\Wireshark Release Notes.html" />
         </Component>
       </DirectoryRef>
     </Fragment>

ui/help_url.c

@@ -144,9 +144,12 @@ topic_action_url(topic_action_e action)
         break;
 
     /* Release Notes */
-    case(LOCALPAGE_RELEASE_NOTES):
-        url = doc_file_url("release-notes.html");
+    case(LOCALPAGE_WIRESHARK_RELEASE_NOTES):
+        url = doc_file_url("Wireshark Release Notes.html");
         break;
+    // case(LOCALPAGE_STRATOSHARK_RELEASE_NOTES):
+    //     url = doc_file_url("Stratoshark Release Notes.html");
+    //     break;
 
     /* local help pages (User's Guide) */
     case(HELP_CONTENT):

ui/help_url.h

@@ -54,7 +54,8 @@ typedef enum {
     LOCALPAGE_MAN_TSHARK,
 
     /* Release Notes */
-    LOCALPAGE_RELEASE_NOTES,
+    LOCALPAGE_WIRESHARK_RELEASE_NOTES,
+    // LOCALPAGE_STRATOSHARK_RELEASE_NOTES,
 
     /* help pages (textfiles or HTML User's Guide) */
     HELP_CONTENT = 200,

ui/qt/wireshark_main_window.cpp

@@ -714,7 +714,7 @@ main_ui_->goToLineEdit->setValidator(goToLineQiv);
     main_ui_->actionHelpDownloads->setToolTip(gchar_free_to_qstring(topic_action_url(ONLINEPAGE_DOWNLOAD)));
     main_ui_->actionHelpWiki->setToolTip(gchar_free_to_qstring(topic_action_url(ONLINEPAGE_WIKI)));
     main_ui_->actionHelpSampleCaptures->setToolTip(gchar_free_to_qstring(topic_action_url(ONLINEPAGE_SAMPLE_CAPTURES)));
-    main_ui_->actionHelpReleaseNotes->setToolTip(gchar_free_to_qstring(topic_action_url(LOCALPAGE_RELEASE_NOTES)));
+    main_ui_->actionHelpReleaseNotes->setToolTip(gchar_free_to_qstring(topic_action_url(LOCALPAGE_WIRESHARK_RELEASE_NOTES)));
 
     showWelcome();
 }

ui/qt/wireshark_main_window_slots.cpp

@@ -3940,7 +3940,7 @@ void WiresharkMainWindow::connectHelpMenuActions()
     connect(main_ui_->actionHelpDownloads, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(ONLINEPAGE_DOWNLOAD); });
     connect(main_ui_->actionHelpWiki, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(ONLINEPAGE_WIKI); });
     connect(main_ui_->actionHelpSampleCaptures, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(ONLINEPAGE_SAMPLE_FILES); });
-    connect(main_ui_->actionHelpReleaseNotes, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(LOCALPAGE_RELEASE_NOTES); });
+    connect(main_ui_->actionHelpReleaseNotes, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(LOCALPAGE_WIRESHARK_RELEASE_NOTES); });
 }
 
 #ifdef HAVE_SOFTWARE_UPDATE

ui/stratoshark/stratoshark_main_window.cpp

@@ -681,6 +681,7 @@ main_ui_->goToLineEdit->setValidator(goToLineQiv);
     main_ui_->actionHelpDownloads->setToolTip(gchar_free_to_qstring(topic_action_url(ONLINEPAGE_DOWNLOAD)));
     main_ui_->actionHelpWiki->setToolTip(gchar_free_to_qstring(topic_action_url(ONLINEPAGE_WIKI)));
     main_ui_->actionHelpSampleCaptures->setToolTip(gchar_free_to_qstring(topic_action_url(ONLINEPAGE_SAMPLE_CAPTURES)));
+    // main_ui_->actionHelpReleaseNotes->setToolTip(gchar_free_to_qstring(topic_action_url(LOCALPAGE_STRATOSHARK_RELEASE_NOTES)));
 
     showWelcome();
 }

ui/stratoshark/stratoshark_main_window_slots.cpp

@@ -3219,6 +3219,7 @@ void StratosharkMainWindow::connectHelpMenuActions()
     connect(main_ui_->actionHelpDownloads, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(ONLINEPAGE_DOWNLOAD); });
     connect(main_ui_->actionHelpWiki, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(ONLINEPAGE_WIKI); });
     connect(main_ui_->actionHelpSampleCaptures, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(ONLINEPAGE_SAMPLE_FILES); });
+    // connect(main_ui_->actionHelpReleaseNotes, &QAction::triggered, this, [=]() { mainApp->helpTopicAction(LOCALPAGE_STRATOSHARK_RELEASE_NOTES); });
 }
 
 #ifdef HAVE_SOFTWARE_UPDATE