Commit Graph

223 Commits

Author SHA1 Message Date
Gerald Combs 673247f04f Windows: Clean up text file packaging.
Convert textify.sh to PowerShell. Use PowerShell's built-in line ending
conversion so that we don't depend on unix2dos.

Only copy the help toc and text files to the staging directory.

Add PowerShell to the Developer's Guide. Fixup some other content.

(asn1/Makefile.inc.nmake contains a call to u2d. Hopefully that's not
a problem.)

Change-Id: I61a92aa54820d01015abb9ffa65815558ae31c71
Reviewed-on: https://code.wireshark.org/review/3487
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
2014-08-14 10:26:31 +00:00
Eugene Sukhodolin 9deb769096 Minor typo corrections
Change-Id: I5962ba6a9b9285095ddacf00307a3094c697461a
Reviewed-on: https://code.wireshark.org/review/3546
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-08-11 06:37:56 +00:00
Gerald Combs 8a34884bf0 Update the Developer's Guide for Chocolatey's Win flex-bison.
Change-Id: Id86a00b521e112e445856251f0c242fbb7a2573b
Reviewed-on: https://code.wireshark.org/review/3482
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-07 23:59:44 +00:00
Gerald Combs 700a474d3b Start converting the User's Guide to AsciiDoc.
Convert the preface and introduction. Update various makefiles.

Change-Id: Id998cabadb6de458f04b7a43bdba4f98e4edb052
Reviewed-on: https://code.wireshark.org/review/3139
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-07-21 15:31:16 +00:00
Joerg Mayer 87895d7d0e Remove some $Id$ lines
Change-Id: Idec3769750f5a433b184e6e9fb44cbad23a29c60
Reviewed-on: https://code.wireshark.org/review/3023
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-07-12 14:31:51 +00:00
Tim Furlong 09839e3a6a Update WSDG win32/win64 quick start guide to include dependencies and
instructions for building QtShark; note alternate cygwin package for
'patch' utility; update example setup script to add Qt bin directory to PATH,
and extract out paths as variables.

Change-Id: Id404b8757dbfd0dc1119b89e01bbe2fa139e2b38
Reviewed-on: https://code.wireshark.org/review/2751
Reviewed-by: Evan Huus <eapache@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-07-02 06:08:39 +00:00
Guy Harris 9fe540c35b dos2unix is now in Utils, not Base.
Change-Id: Ib430582270a2b788843785fd5aa7148ebe0f8871
Reviewed-on: https://code.wireshark.org/review/2597
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-24 00:55:55 +00:00
Guy Harris 858c48acc6 Point the user at http://www.cygwin.com/install.html for downloads.
That page gives a bit more information.

Change-Id: Id0c708ede50aa9e6c6583f6957c355a630fa7e7e
Reviewed-on: https://code.wireshark.org/review/2578
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-23 17:04:58 +00:00
Guy Harris d51faaaee7 Point to the Cygwin mirrors page.
If you choose to install from the Intertubes, you probably want to
choose a nearby mirror site, rather than downloading from halfway across
the world; the list of download sites in setup*.exe's UI gives no
indication of where the mirror sites are, so you could end up picking
one to which you have a slow Internet path.  Tell the user about the
list of mirror sites on the Cygwin Web site, as that list *does* give
geographical locations.

Change-Id: Idf035d288885ee45db7b3627af969e64270487a1
Reviewed-on: https://code.wireshark.org/review/2555
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22 18:39:12 +00:00
Guy Harris a59d62ef2d 64-bit Cygwin's dependencies for Bison are wrong; it doesn't require m4.
Change-Id: Id6a6c0a7c09ed1d9eb1e1d522930e3f94e7b20d6
Reviewed-on: https://code.wireshark.org/review/2554
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22 18:32:36 +00:00
Guy Harris c935411f9b Remove trailing white space, copyedit, add a missing period.
Change-Id: I300d723a6f93293ebdf97c5ef6ac3e9b72c692ee
Reviewed-on: https://code.wireshark.org/review/2533
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22 02:53:50 +00:00
Guy Harris e088923059 Update to reflect current reality.
Cygwin has both 32-bit and 64-bit versions, with separate installers.

Change-Id: I02b2699b9b3dbd3b3c65f7a372c6d423829f449b
Reviewed-on: https://code.wireshark.org/review/2532
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-06-22 02:51:11 +00:00
Sean O. Stalley a53cd45483 Fixed typo in docbook (usuall to usually)
Change-Id: I1aad1d6487cb6acd52bb851c08d9c4965bbb9f55
Reviewed-on: https://code.wireshark.org/review/1449
Reviewed-by: Evan Huus <eapache@gmail.com>
2014-05-01 03:03:25 +00:00
Bill Meier faec7514cf SVN --> GIT in a few places. Fixes Bug #10060.
Change-Id: I5dcf7699e295dcdbd1e870af5ec68b010a63bf6f
Reviewed-on: https://code.wireshark.org/review/1434
Reviewed-by: Bill Meier <wmeier@newsguy.com>
2014-04-30 03:28:33 +00:00
Bill Meier b84ce5ca43 Comment out a section re SVN usage; svn ==> git in a few cases; Fix some typos.
Change-Id: I0bd7a7d4bdcc566af6b8f672a25fb937176fde21
Reviewed-on: https://code.wireshark.org/review/1060
Reviewed-by: Bill Meier <wmeier@newsguy.com>
Tested-by: Bill Meier <wmeier@newsguy.com>
2014-04-10 18:00:07 +00:00
Gerald Combs 0a4993500b Add a backporting chapter.
Change-Id: Id0e017b18e95d6703e166fa09f767200d8ed1f8d
Reviewed-on: https://code.wireshark.org/review/925
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-04-02 23:08:57 +00:00
Joerg Mayer 5f508e8b29 Small updates to the setup process documentation
Change-Id: Ie6dc3a8254e30495945155f058f1ef10a75c4745
Reviewed-on: https://code.wireshark.org/review/700
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-03-16 19:01:25 +00:00
Gerald Combs d75d5a197e Fix indentation and numbering.
Change-Id: Ic1b528db9128420e106affcc8b3639d2d5fc65c0
Reviewed-on: https://code.wireshark.org/review/397
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25 23:42:01 +00:00
Gerald Combs 621a9c5023 Add back an anchor removed in gc55c57a.
Change-Id: I9795278b759d1a965abd9b22dc023c70fce19b77
Reviewed-on: https://code.wireshark.org/review/391
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25 21:58:20 +00:00
Gerald Combs c55c57ad72 Add Git+Gerrit command line instructions.
Add a Git+Gerrit command line example to the Developer's Guide. Convert
some Subversion text to Git.

Skip building the Developer's Guide if we don't have a2x.

Change-Id: I62e9e71eb3ffc07d8677df35b4b197f53f77b4f2
Reviewed-on: https://code.wireshark.org/review/384
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-25 20:26:50 +00:00
Jeff Morriss cd02def632 Clean up some more subversion references in the documentation.
Change-Id: Id6cf1a617bff3e09e47933a69d505393502874d1
Reviewed-on: https://code.wireshark.org/review/370
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
Reviewed-by: Evan Huus <eapache@gmail.com>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-02-25 18:04:55 +00:00
Gerald Combs 5e3113e7c9 Finish converting the Developer's Guide to AsciiDoc.
Add developer-guide-docinfo.xml, which lets us carry over DocBook front
matter. Remove the meta_info chapter. Most of its contents are now in
developer-guide-docinfo.xml. Add a DocBook revision history based on
hints from the Git/SVN/CVS revision history.

Comment out or note makefile content that's no longer necessary for
converting the Developer's Guide but will be useful for converting the
User's Guide. Fix building the release notes with CMake. Other minor
changes. Tested with Autotools, nmake, and CMake.

Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a
Reviewed-on: https://code.wireshark.org/review/155
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-11 18:04:45 +00:00
Gerald Combs 1dc06a2681 Convert the user interface chapter to AsciiDoc.
Start mentioning Qt. Update and add HIG links.

Change-Id: Iac984045b03a96862981d58ff63c9ee6bcdbbce8
Reviewed-on: https://code.wireshark.org/review/127
Tested-by: Wireshark Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-06 20:59:00 +00:00
Gerald Combs 4dd6451a91 Convert the dissection chapter to AsciiDoc.
Change-Id: Ieccd2ad235576b9ec6013ddb23a8373ccf2f8cdf
Reviewed-on: https://code.wireshark.org/review/92
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-03 18:32:32 +00:00
Gerald Combs 1b2145d931 Convert three more WSDG chapters: works, build, and capture.
Start adding references to Qt and wsutil. Fix a file extension in
CMakeLists.txt.

Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53
Reviewed-on: https://code.wireshark.org/review/79
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:12:17 +00:00
Gerald Combs ec6fc7690b Convert the libraries chapter to AsciiDoc.
Add some docbook-related entries to .gitignore. Whoever maintains the
Windows libraries has done a terrible job of keeping this chapter up to
date.

Change-Id: Ic6dcbd9e8369eae9f07403bd3f805a515886f542
Reviewed-on: https://code.wireshark.org/review/72
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01 19:30:01 +00:00
Gerald Combs bdafbad955 Convert the tools chapter to AsciiDoc.
Replace SVN text with Git, other mostly-minor edits.

Change-Id: I41b602cc9334656dc8e5f37c33fb6cd660043d17
Reviewed-on: https://code.wireshark.org/review/69
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01 18:27:15 +00:00
Gerald Combs 257e301696 Convert the quick setup chapter to AsciiDoc and start converting its
content to Git.

svn path=/trunk/; revision=54985
2014-01-27 18:43:57 +00:00
Gerald Combs 59990b7031 Fix a section name conflict.
svn path=/trunk/; revision=54973
2014-01-27 05:10:34 +00:00
Gerald Combs 5b17df040e Restore an inadvertently deleted file.
svn path=/trunk/; revision=54972
2014-01-27 04:34:25 +00:00
Gerald Combs 5344e2f2fc Migrate the build environment introduction to AsciiDoc.
svn path=/trunk/; revision=54971
2014-01-27 04:20:44 +00:00
Gerald Combs e61a6533e7 Convert the preface to AsciiDoc with minor edits.
svn path=/trunk/; revision=54970
2014-01-27 03:08:01 +00:00
Gerald Combs 4a32b10948 Comment out the "diff" section for now. We'll have to update it for "git
diff" at some point.

svn path=/trunk/; revision=54958
2014-01-25 03:27:22 +00:00
Gerald Combs b326fe61c7 Uncomment anchors.
svn path=/trunk/; revision=54957
2014-01-25 02:26:12 +00:00
Gerald Combs 927914a2cf Fix xpath selector. Clean up whitespace.
svn path=/trunk/; revision=54955
2014-01-25 01:09:28 +00:00
Gerald Combs 4c5bb90167 Migrate more SVN content to Git+Gerrit.
svn path=/trunk/; revision=54954
2014-01-25 01:01:04 +00:00
Gerald Combs 0555a544f4 Migrate some of the SVN-specific content to Git.
svn path=/trunk/; revision=54953
2014-01-25 00:17:46 +00:00
Gerald Combs 8997fb0d89 Start migrating the Developer's Guide to AsciiDoc. So far only one
chapter (WSDG_chapter_sources) has been converted.

Conversion was done using the script in
https://code.wireshark.org/review/#/c/9/ along with manual cleanup.
Changes are mostly limited formatting.

It's helpful to have a copy of the pre-conversion guide for comparison.
I've placed a chunked copy online at
http://www.wireshark.org/~gerald/wsdg_html_2014_01/ .

Tested under Autotools. Nmake and CMake will likely break. I'll take a
look shortly. If only we had documention adding a feature branch to
Gerrit and using it to test different platforms...

svn path=/trunk/; revision=54945
2014-01-24 18:55:27 +00:00
Bill Meier 8ab9c55618 From Ville Skyttä: Spelling Fixes
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9591


svn path=/trunk/; revision=54387
2013-12-23 15:53:13 +00:00
Michael Mann fd2f05446d Update documentation for tcp_dissect_pdus. Bug 9491 (https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9491)
From Peter Wu: update to README.dissector
From me: update to WSDG_chapter_dissection.xml

svn path=/trunk/; revision=53678
2013-11-30 20:48:46 +00:00
Gerald Combs 39d3b8c16a Remove U3 references.
svn path=/trunk/; revision=52166
2013-09-22 00:48:03 +00:00
Gerald Combs bd33f6a366 Mention that building using Python 3 *should* work, but recommend using
2.7. Make the minimum version 2.5.

svn path=/trunk/; revision=51124
2013-08-02 16:37:45 +00:00
Jörg Mayer 957436d5b8 Add a paragraph what to try if installation of the SDK fails.
svn path=/trunk/; revision=50862
2013-07-24 01:54:22 +00:00
Martin Kaiser 8bd14d8dba cygwin's dos2unix belongs to the Base category
svn path=/trunk/; revision=50554
2013-07-13 11:41:34 +00:00
Guy Harris 5d87a8c461 WS_DLL_PUBLIC is now always WS_DLL_PUBLIC_NOEXTERN with "extern" added;
just define WS_DLL_PUBLIC_NOEXTERN inside the ifdefs, and define
WS_DLL_PUBLIC as WS_DLL_PUBLIC_NOEXTERN followed by "extern".

Then rename WS_DLL_PUBLIC_NOEXTERN to WS_DLL_PUBLIC_DEF, to clarify that
it's what should be used for definitions; at least on Windows, you
*have* to use it when declaring arrays without a size, and, whilst you
might be able to use WS_DLL_PUBLIC for definitions of functions and
perhaps data definitions other than no-size arrays, it might be clearer
to rename WS_DLL_PUBLIC to WS_DLL_PUBLIC_DECL and use it only for
declarations.

svn path=/trunk/; revision=50334
2013-07-03 01:43:39 +00:00
Martin Kaiser cee4e923ae the dos2unix cygwin package is required for compiling on windows
svn path=/trunk/; revision=49972
2013-06-17 00:57:16 +00:00
Gerald Combs aa9080b735 Update the table style. Minor text fixes.
svn path=/trunk/; revision=49907
2013-06-12 15:37:04 +00:00
Gerald Combs 66a7193699 Convert the compiler table to a variablelist so that we don't end up
cramming a bunch of text into a bunch of narrow columns.  Remove the
.NET framework 2.0 SDK and Visual Studio 2005. Sort items from newest to
oldest.

svn path=/trunk/; revision=49892
2013-06-12 00:42:31 +00:00
Pascal Quantin 6c72b855f9 Fix a typo error as reported on -dev
svn path=/trunk/; revision=49694
2013-06-02 16:54:16 +00:00
Jeff Morriss f93348a2f7 As suggested by Moshe Kaplan in https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8712 :
When pointing people to the mailing lists, point them directly to the lists
page rather than explaining where to look for the link on the main page (the
directions were several years out of date).

While there also fix up some of the indentation and add a link to the Q&A site
in the developer's guide.

svn path=/trunk/; revision=49553
2013-05-24 14:45:55 +00:00