Some cleanups.
More use of "UNIX-like" as the term for "macOS and Linux and *BSD and Solaris and AIX and..." or, alternatively, for "not Windows". Add Fedora as a Linux distribution for which packages are available. Use "Windows" rather than "Win32" in more cases; "Win32" dates back to the days when the big difference was between Boring Old 16-bit Windows and modern shiny new 32-bit Windows, but the former is now dead and the latter now supports both 32-bit and 64-bit machines and software. More people have probably never heard "Win32" but are familiar with "Windows". *ALL* UNIX-like platforms support symlinks; Linux wasn't even the first one, it just picked them up from the UN*Xes with which it was trying to be compatible. Change-Id: I254e74f0ed3c86b55d00f9e8d7b78d009b61fb5e Reviewed-on: https://code.wireshark.org/review/30178 Reviewed-by: Guy Harris <guy@alum.mit.edu>
This commit is contained in:
parent
7388ea9397
commit
fd78e3f2ed
|
@ -24,7 +24,7 @@ which will provide a lot of general information about it.
|
||||||
|
|
||||||
=== Supported Platforms
|
=== Supported Platforms
|
||||||
|
|
||||||
Wireshark currently runs on most UNIX platforms and various Windows
|
Wireshark currently runs on most UNIX-like platforms and various Windows
|
||||||
platforms. It requires Qt, GLib, libpcap and some other libraries in
|
platforms. It requires Qt, GLib, libpcap and some other libraries in
|
||||||
order to run.
|
order to run.
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ to mailto:{wireshark-dev-list-email}[].
|
||||||
Binary packages are available for the following platforms along with many
|
Binary packages are available for the following platforms along with many
|
||||||
others:
|
others:
|
||||||
|
|
||||||
==== Unix
|
==== Unix and Unix-like platforms
|
||||||
|
|
||||||
* Apple macOS
|
* Apple macOS
|
||||||
|
|
||||||
|
@ -55,12 +55,14 @@ others:
|
||||||
|
|
||||||
* Oracle Solaris
|
* Oracle Solaris
|
||||||
|
|
||||||
==== Linux
|
===== Linux
|
||||||
|
|
||||||
* Debian GNU/Linux
|
* Debian GNU/Linux
|
||||||
|
|
||||||
* Ubuntu
|
* Ubuntu
|
||||||
|
|
||||||
|
* Fedora
|
||||||
|
|
||||||
* Gentoo Linux
|
* Gentoo Linux
|
||||||
|
|
||||||
* IBM S/390 Linux (Red Hat)
|
* IBM S/390 Linux (Red Hat)
|
||||||
|
@ -231,11 +233,11 @@ e.g. if you need a distribution for a special audience, see
|
||||||
|
|
||||||
==== Source code distributions
|
==== Source code distributions
|
||||||
|
|
||||||
It’s still common for UNIX developers to give the end user a source
|
It's still common for developers for UNIX-like platforms to give the
|
||||||
tarball and let the user compile it on their target machine (configure,
|
enduser a source tarball and let the user compile it on their target
|
||||||
make, make install). However, for different UNIX (Linux) distributions
|
machine (configure make make install). However, for different UNIX
|
||||||
it’s becoming more common to release binary packages (e.g. .deb or .rpm
|
and UNIX-like systems, such as Linux distributions, it's becoming more
|
||||||
files) these days.
|
common to release binary packages (e.g., .deb or .rpm files) these days.
|
||||||
|
|
||||||
You should use the released sources if you want to build Wireshark from
|
You should use the released sources if you want to build Wireshark from
|
||||||
source on your platform for productive use. However, if you going to
|
source on your platform for productive use. However, if you going to
|
||||||
|
@ -507,7 +509,7 @@ such as passwords. Visibility of such files can be limited to certain
|
||||||
groups in the Bugzilla database though.
|
groups in the Bugzilla database though.
|
||||||
====
|
====
|
||||||
|
|
||||||
==== Reporting Crashes on UNIX/Linux platforms
|
==== Reporting Crashes on UNIX-like platforms
|
||||||
|
|
||||||
When reporting crashes with Wireshark, it is helpful if you supply the
|
When reporting crashes with Wireshark, it is helpful if you supply the
|
||||||
traceback information (besides the information mentioned in
|
traceback information (besides the information mentioned in
|
||||||
|
|
|
@ -348,7 +348,7 @@ remember later that you really did change something before.
|
||||||
If you have changed your source tree, you have to merge the official
|
If you have changed your source tree, you have to merge the official
|
||||||
changes since the last update into your source tree. You will install
|
changes since the last update into your source tree. You will install
|
||||||
the content of the `.tar.xz` file into a new directory and use a good
|
the content of the `.tar.xz` file into a new directory and use a good
|
||||||
merge tool (e.g. http://winmerge.sourceforge.net/[]for Win32) to bring
|
merge tool (e.g. http://winmerge.sourceforge.net/[]for Windows to bring
|
||||||
your personal source tree in sync with the official sources again.
|
your personal source tree in sync with the official sources again.
|
||||||
|
|
||||||
This method can be problematic and can be much more difficult and
|
This method can be problematic and can be much more difficult and
|
||||||
|
@ -399,7 +399,7 @@ $ cmake -LH ../wireshark
|
||||||
|
|
||||||
to see what options you have.
|
to see what options you have.
|
||||||
|
|
||||||
==== Win32 native
|
==== Windows native
|
||||||
|
|
||||||
Follow the build procedure in <<ChWin32Build>> to build Wireshark.
|
Follow the build procedure in <<ChWin32Build>> to build Wireshark.
|
||||||
|
|
||||||
|
@ -423,7 +423,7 @@ installed version first.
|
||||||
|
|
||||||
[[ChSrcRunFirstTimeUnix]]
|
[[ChSrcRunFirstTimeUnix]]
|
||||||
|
|
||||||
==== Unix/Linux
|
==== Unix-like platforms
|
||||||
|
|
||||||
After a successful build you can run Wireshark right from the build
|
After a successful build you can run Wireshark right from the build
|
||||||
directory. Still the program would need to know that it’s being run from
|
directory. Still the program would need to know that it’s being run from
|
||||||
|
@ -451,7 +451,7 @@ be informative when things don't work as expected.
|
||||||
[[ChSrcRunFirstTimeWin32]]
|
[[ChSrcRunFirstTimeWin32]]
|
||||||
|
|
||||||
|
|
||||||
==== Win32 Native
|
==== Windows Native
|
||||||
|
|
||||||
During the build all relevant program files are collected in a
|
During the build all relevant program files are collected in a
|
||||||
subdirectory `run\RelWithDebInfo`. You can run the program from there by
|
subdirectory `run\RelWithDebInfo`. You can run the program from there by
|
||||||
|
@ -464,7 +464,7 @@ launching the Wireshark.exe executable.
|
||||||
[[ChSrcUnixDebug]]
|
[[ChSrcUnixDebug]]
|
||||||
|
|
||||||
|
|
||||||
==== Unix/Linux
|
==== Unix-like platforms
|
||||||
|
|
||||||
You can debug using command-line debuggers such as gdb, dbx, or lldb.
|
You can debug using command-line debuggers such as gdb, dbx, or lldb.
|
||||||
If you prefer a graphic debugger, you can use the Data Display Debugger
|
If you prefer a graphic debugger, you can use the Data Display Debugger
|
||||||
|
@ -483,7 +483,7 @@ See https://developer.gnome.org/glib/stable/glib-running.html[]
|
||||||
[[ChSrcWin32Debug]]
|
[[ChSrcWin32Debug]]
|
||||||
|
|
||||||
|
|
||||||
==== Win32 native
|
==== Windows native
|
||||||
|
|
||||||
You can debug using the Visual Studio Debugger or WinDbg. See the section
|
You can debug using the Visual Studio Debugger or WinDbg. See the section
|
||||||
on using the <<ChToolsDebugger, Debugger Tools>>.
|
on using the <<ChToolsDebugger, Debugger Tools>>.
|
||||||
|
@ -817,10 +817,12 @@ change, you can run git commit --no-verify to skip running the hooks. Warning: u
|
||||||
Change-ID to your commit. In case you are not updating an existing patch you may generate
|
Change-ID to your commit. In case you are not updating an existing patch you may generate
|
||||||
a Change-ID by running git review -i (or git commit --amend if don't use git review).
|
a Change-ID by running git review -i (or git commit --amend if don't use git review).
|
||||||
+
|
+
|
||||||
Additionally, if your system supports symbolic links (like Linux), you can use them
|
|
||||||
instead of copying files. Running ln -s ./tools/pre-commit .git/hooks creates a symbolic
|
Additionally, if your system supports symbolic links, as all UNIX-like
|
||||||
link that will make the hook to be up-to-date with the current master. The same can
|
platforms do, you can use them instead of copying files. Running ln -s
|
||||||
be done for commit-msg script.
|
./tools/pre-commit .git/hooks creates a symbolic link that will make the
|
||||||
|
hook to be up-to-date with the current master. The same can be done for
|
||||||
|
commit-msg script.
|
||||||
|
|
||||||
|
|
||||||
* _Fuzz test your changes!_ Fuzz testing is a very
|
* _Fuzz test your changes!_ Fuzz testing is a very
|
||||||
|
@ -1098,7 +1100,7 @@ to build the macOS Package.
|
||||||
|
|
||||||
[[ChSrcNSIS]]
|
[[ChSrcNSIS]]
|
||||||
|
|
||||||
==== Win32: NSIS .exe installer
|
==== Windows: NSIS .exe installer
|
||||||
|
|
||||||
The _Nullsoft Install System_ is a free installer generator for Windows
|
The _Nullsoft Install System_ is a free installer generator for Windows
|
||||||
systems. Instructions on installing it can be found in <<ChToolsNSIS>>.
|
systems. Instructions on installing it can be found in <<ChToolsNSIS>>.
|
||||||
|
@ -1129,7 +1131,7 @@ the _packaging/nsis_ directory in your build directory.
|
||||||
|
|
||||||
[[ChSrcPortableApps]]
|
[[ChSrcPortableApps]]
|
||||||
|
|
||||||
==== Win32: PortableApps .paf.exe package
|
==== Windows: PortableApps .paf.exe package
|
||||||
|
|
||||||
_PortableApps.com_ is an environment that lets users run popular applications
|
_PortableApps.com_ is an environment that lets users run popular applications
|
||||||
from portable media such as flash drives and cloud drive services.
|
from portable media such as flash drives and cloud drive services.
|
||||||
|
|
Loading…
Reference in New Issue