aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.developer
AgeCommit message (Collapse)AuthorFilesLines
2024-02-01wsutil+tools: Version info updatesGerald Combs1-1/+1
Define VCS_NUM_COMMITS and VCS_COMMIT_ID in vcs_version.h. Use them to return the Logray version in get_lr_vcs_version_info and use that where appropriate. Rename VCSVERSION to VCS_VERSION.
2023-12-18Check for some document URLsMartin Mathieson1-2/+2
2023-10-31Use C99 instead of GLib types in doc+docbookDavid Perry1-2/+3
Ran `tools/convert-glib-types.py` over the files in `doc/` and `docbook/`, then manually checked/massaged/reverted results as appropriate. One small step towards addressing #19116
2023-09-17Fix some spelling errorsMartin Mathieson1-1/+1
2023-06-12Add a script to convert GLib types to their C equivalentsGerald Combs1-10/+9
Convert wsutil/802_11-utils.[ch] as a test. Update some of our documentation. Ping #19116
2023-04-08Some updates to README.developerMartin Mathieson1-24/+32
2023-03-19doc: Don't refer to tvb_get_faked_unicodeJohn Thacker1-26/+46
tvb_get_faked_unicode hasn't existed for nine years. Recommend tvb_get_string_enc() instead.
2023-02-06Do not require using wsgcrypt.hJoão Valverde1-3/+3
The reason to use wsgcrypt.h was to wrap it around DIAG_OFF() macros and that should no longer be necessary.
2023-01-12Remove WS_DISABLE_ASSERTJoão Valverde1-2/+2
Assertions can be enabled/disabled using WS_DISABLE_DEBUG. The extra granularity afforded by WS_DISABLE_ASSERT seems unnecessary.
2022-09-27README.Developer: Add notes about string encoding and best-practicesJoão Valverde1-0/+26
2022-08-23Qt6: Adapt various docsRoland Knall1-2/+2
2022-04-28docs: Update reference to minimum versions of GLib and QtJohn Thacker1-1/+1
2022-02-06Docs: Accurately describe our minimum GLib and where to get itJim Young1-1/+1
2021-12-18Docs: Fix a README.developer code exampleJoão Valverde1-3/+3
Remove spurious "int". Also prefer "g_string_printf", just for stylistic reasons.
2021-12-18Docs: Add more info about transitioning to C99 fixed-width typesJoão Valverde1-7/+23
2021-12-16Docs: First pass to update README.developer to C11João Valverde1-46/+46
Update to reflect the transition from C99 to C11. Remove obsolete comments and recommendations. Add a bit about transitioning to C fixed width types. Related to #17768.
2021-11-01README.developer: put items about Windows together.Guy Harris1-4/+4
Move the item about MinGW-w64 up after the earlier item about Windows portability in general.
2021-11-01README.developer: Add note about portability on WindowsJoão Valverde1-0/+10
2021-10-26docs: Add some notes about project APIsJoão Valverde1-1/+40
2021-10-22Add new global header wireshark.h with guidelineJoão Valverde1-0/+78
Remove ws_diag_control.h from config.h because that was a workaround for the lack of a public global header. Fix the resultant build errors.
2021-10-11Fix some spelling errorsMartin Mathieson1-1/+1
2021-10-05Update README.developerAndersBroman1-1/+1
2021-10-05docs: Add section about architecture to README.developerJoão Valverde1-1/+20
2021-07-21First pass pinfo->pool conversionEvan Huus1-3/+3
Automated find/replace of wmem_packet_scope() with pinfo->pool in all files where it didn't cause a build failure. I also tweaked a few of the docs which got caught up.
2021-07-09Rename version.h to be more descriptiveJoão Valverde1-1/+1
Version.h is too generic. This is specific to VCSVERSION and that should be made more obvious and discoverable.
2021-05-19Disable assertions for release buildsJoão Valverde1-1/+30
Currently our build generates very many warnings if G_DISABLE_ASSERT is defined. Add ws_assert() and ws_assert_not_reached() to incrementally replace existing assertions and then disable them using WS_DISABLE_ASSERT. Assertions are disabled with CMake build type Release. By default the build type is RelWithDebInfo so the current behaviour of enabling assertions by default is (for now) preserved. Add some notes to README.Developer.
2021-02-28Remove and replace obsolete ws_snprintf() definitionJoão Valverde1-10/+14
Since fe94133f0d06935bb5f2afe21f59bbb078d3d9d3 ws_snprintf() and ws_vsnprintf() don't actually do anything anymore. The return value of ws_[v]snprintf was discarded before, now it too conforms to C99.
2021-02-25Docs: Recommend EditorConfig.Gerald Combs1-26/+19
Note that we use EditorConfig in the WSDG and README.developer, and that you should make sure your editor uses it. Recommend 4 space indentation more strongly. Ping #17253. Reorder and reword the coding style sections of each document while we're here.
2020-10-12Fix spelling errors in the documentationРоман Донченко1-1/+1
2020-09-25README.developer: Fix some quotation marks around function namesThomas Vogt1-2/+2
2020-09-04README.developer: Note that sources can use UTF-8.Gerald Combs1-10/+12
We started allowing source files to be encoded as UTF-8 in April 2019 in bd75f5af0a. Update README.developer to match. README.developer no longer has a "Code style" section, so update the Developer's Guide to point to the "Portability" section.
2019-12-10More Qt minimum version updates.Gerald Combs1-1/+1
Update the minimum version in various documents. Remove some no-longer-needed code from scripts that call windeployqt. Change-Id: I16da4bced9780c9f1b1969aae7c52e2fce1968aa Reviewed-on: https://code.wireshark.org/review/35391 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2018-04-06Remove some references to Qt4.Gerald Combs1-8/+5
Change-Id: I50f5abafb8adf18a5407427f7feb260301df45cc Reviewed-on: https://code.wireshark.org/review/26771 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-04-02doc: minor changes in README files.Dario Lombardo1-2/+0
Change-Id: I5b21ade727f9c4bed6545e69d87082baafaefa2b Reviewed-on: https://code.wireshark.org/review/26702 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-10-21Warn the developer if we're building with GTK+.Gerald Combs1-4/+9
Move The Slowest Migration In The History Of Ever a little further along. Change-Id: Ib8b49708e7036dd412a7ffc8660ded9f681374c0 Reviewed-on: https://code.wireshark.org/review/24006 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-15Convert README to README.md.Gerald Combs1-4/+4
Convert the contents of the top-level README to Markdown and give it a .md extension. Most of our documentation is plain text or AsciiDoc, but the top-level README file in a Git repository is special in that many online browsers will show the README contents along with the directory listing and those browsers tend to favor Markdown. This is true of GitHub (which we're currently mirroring to), Gerrit via its Gitiles plugin (which we're not yet using but likely will), and other places. Add "foreign" to AM_INIT_AUTOMAKE. There is probably a joke to be made here about the FSF and border walls. Change-Id: I87c306d74864e1f0a432225b160a1b4483ee946c Reviewed-on: https://code.wireshark.org/review/23049 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-06-28Don't worry about initializing auto aggregates with non-constant values.Guy Harris1-9/+16
On UN*X, you can get C99-or-later compilers, and we request that in the autoconf script, so it's really a requirement. At least as I read https://msdn.microsoft.com/en-us/library/34h23df8%28v=vs.100%29.aspx Visual Studio 2010 (and earlier, going back to VS .NET 2003) supports the "Use of block-scope variables initialized with nonconstant expressions", with an example of an aggregate (array) initialization involving function calls, so it sounds as if it's available on Windows with any version of VS that we support. (If I've missed something, it'll presumably show up when something is built with MSVC, and we can update this at that point.) So the only thing to avoid is initializing global or static variables with a value that has to be evaluated at run time (the ability to do that is probably present in most environments, as I think C++ constructors for variables with static storage duration might have to be evaluated before main() is called, but I guess few C compilers bother to use it). Expand the example in the hopes of avoiding confusion between "static storage duration" (which something declared "static" has, but which anything declared with file scope, whether declared "static" or not, also has) and "static storage duration and internal linkage", which is what the "static" keyword specifies. Change-Id: I338eb0892e656c2ab59519e4bf76e1dfbec2fa7d Reviewed-on: https://code.wireshark.org/review/22434 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-06-27Fix the "don't initialize with non-constant variables" item.Guy Harris1-4/+20
It only applies to variables with static storage duration, i.e. global and static variables. Expand the example of how to do it, to make it a bit clearer. Change-Id: Ie0c473a35a77351dd10d6c9df2c34a39f077fca4 Reviewed-on: https://code.wireshark.org/review/22430 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-02-13Make Libgcrypt a mandatory dependencyPeter Wu1-4/+3
Removed all guards for HAVE_LIBGCRYPT, change autotools and CMake to error out if it is not available. Update release notes, developer documentation and README with the new status. Clarify relation with GnuTLS in macosx-setup.sh. Install Libgcrypt via brew script. Motivation for this change is that many dissectors depend on Libgcrypt and having it optional increases the maintenance burden (there have been several compile issues in the past due to the optional status). Furthermore, wsutil has crypto code that can be replaced by Libgcrypt. Change-Id: Idf0021b8c4cd5db70b8766f7dcc2a8b3acbf042f Link: https://www.wireshark.org/lists/wireshark-dev/201702/msg00011.html Reviewed-on: https://code.wireshark.org/review/20030 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2016-10-20Officially require Qt 4.8 or newerPeter Wu1-5/+4
Since v2.3.0rc0-1002-g1cd2255, Qt 4.8 became mandatory, reflect this in the version requirements. This will not affect a lot of distributions (RHEL and SLES only had Qt 4.6). For a more complete list of supported platforms, see https://wiki.wireshark.org/Development/Support_library_version_tracking While at it, correct some other minimum versions in documentation. Change-Id: I11f2dfba72c75429f6838404a81ed3b3dc302d5f Reviewed-on: https://code.wireshark.org/review/18314 Reviewed-by: Michal Labedzki <michal.labedzki@tieto.com> Petri-Dish: Anders Broman <a.broman58@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-09-06Allow a lot more C99 featuresPeter Wu1-21/+14
Flexible array members are supported by gcc, clang and even MSVC2013. Note, so far it was only used in the Windows-specific airpcap.h. Trailing commas in enum declaration are already in use since for these dissectors (commit ID is the first occurrence): epan/dissectors/packet-gluster.h v2.1.0rc0-1070-g3b706ba epan/dissectors/packet-ipv6.c v2.1.2rc0-81-ge07b4aa epan/dissectors/packet-netlink.h v2.3.0rc0-389-gc0ab12b epan/dissectors/packet-netlink-netfilter.c v2.3.0rc0-239-g1767e08 epan/dissectors/packet-netlink-route.c v2.3.0rc0-233-g2a80b40 epan/dissectors/packet-quic.c v2.3.0rc0-457-gfa320f8 Inline functions using the "inline" keyword are supported via all glib versions we support (if it is missing, glib will define a suitable inline macro). Other c99 functions listed in the README.developer document were found to be compatible with GCC 4.4.7, Clang 3.4.2 and MSVC 2013. Change-Id: If5bab03bfd8577b15a24bedf08c03bdfbf34317a Reviewed-on: https://code.wireshark.org/review/17421 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2016-06-15documentation: Suggest using prefixed public symbolsBalint Reczey1-0/+5
Change-Id: I9153756b0e921fd74d7df9d119337f5484856ba0 Reviewed-on: https://code.wireshark.org/review/15940 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-04-21Add option to disable version.hJoão Valverde1-0/+10
If the file '.git/wireshark-disable-versioning' exists then version.h will be commented out. Change-Id: If481b673463408a69c2ecf7c2e66d08c5855537f Reviewed-on: https://code.wireshark.org/review/14932 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-03-29Update min. GLib version and add Qt version checksJaap Keuter1-5/+5
The document describes why and how to version check, but 1) is not up to date with respect to minimum GLib version 2) does not yet mention Qt version requirement and check. This change addresses both issues. Change-Id: Ibb56c02cf48f6a4c6270b20686ca4d6e8aaf99d1 Reviewed-on: https://code.wireshark.org/review/14669 Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
2016-03-14Add EditorConfig reference to README.developerJoão Valverde1-6/+23
Change-Id: I595e94bd0274e3ee3c1d8764fc6c93f28993c30f Reviewed-on: https://code.wireshark.org/review/14468 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2016-01-02Note that variadic macros *can* be sued.Guy Harris1-1/+4
Change-Id: I15bfda76256e5d1084ad7c64006f93afaf071a9e Reviewed-on: https://code.wireshark.org/review/13010 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-11-08Update to reflect current reality.Guy Harris1-29/+20
Change-Id: I98a104407feb21d038653e41c547c7ebc27771cb Reviewed-on: https://code.wireshark.org/review/11636 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2015-10-05Allow use of variadic macrosPeter Wu1-17/+0
Remove variadic macros restriction (c99, c++11 feature) from README.developer. GCC, Clang, MSVC 2005 all support it. Enable -Wno-variadic-macros in configure.ac and CMakeLists.txt when -Wpedantic is enabled (which would enable -Wvariadic-macros). For all files matching 'define\s*\w+[0-9]\(', replace "FOO[0-9]" by "FOO" and adjust the macro definition accordingly. The nbap dissector was regenerated after adjusting its template and .cnf file. The generated code is the same since all files disabled the debug macros. Discussed at: https://www.wireshark.org/lists/wireshark-dev/201209/msg00142.html https://www.wireshark.org/lists/wireshark-dev/201510/msg00012.html Change-Id: I3b2e22487db817cbbaac774a592669a4f44314b2 Reviewed-on: https://code.wireshark.org/review/10781 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-12-12doc: remove some references to the now defunct python supportPascal Quantin1-1/+0
Change-Id: Ibba3168516ef28ad050f5f70045acf3935f2b233 Reviewed-on: https://code.wireshark.org/review/5738 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2014-09-17Update the doc directory to use https://www.wireshark.org.Gerald Combs1-2/+2
Change-Id: I9bfc57cb6b6ab6962b80ff58d98eb351d6f69829 Reviewed-on: https://code.wireshark.org/review/4140 Reviewed-by: Gerald Combs <gerald@wireshark.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-13 09:33:30 +0000