The seemingly never ending Docs #2
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
improved MSVC x64 support suggested by robertolarcher (Pull Request libnet#58), README.win32 adjustments, added (Linux only) Travis test yml as well as other tiny fixes.
last chance, appveyor1
msvcbuild.bat now builds libnet from ANY cmd/powershell not just the Developer Command Prompt
goto %1 didn't apply anymore...
batch file now creates "lib" folder, libs have version number and other minor changes; lua bindings doesn't work (yet)
Samples are in need of additional linking (-lws2_32, -lpcap) and are complaining about code in libnet_resolve.c, libnet_write.c and libnet_raw.c. Not sure how concerning that is... I better get my pcap manual :-D
Libnet now builds gracefully with MinGW (including samples). There's a lot of fine tuning to be done and it needs testing on my other MinGW distros (including cross). This push is therefore just to see if Linux, Mac and Windows (MSVC) are still happy.
the build system should be up to the latest standards with this one. Except for docs, that's up next...
still ugly, but at least it works again
This was suprisingly easy. Hail clang!
On Linux at least, most if not all ethertypes defined in libnet-headers.h are also defined in the compiler's standard include files (net/ethertypes.h, linux/if_ether.h and maybe others too) That's not a problem because ethertypes are a IEEE 802.3 standard. But for some reason, the Hex letter digits in libnet-headers.h are all lowercase but those in the standard include files are all uppercase (as they are throughout all RFCs(see RFC7042 and RFC2464). This harmless macro redefinition causes clang (and maybe others too) to go berserk. Maybe it's time to let the standard include files handle ethertypes instead of libnet-headers.h. For now, I am just going to add diagnostic pragmas to the conflicting ethertypes to suppress macro redefinition warnings caused this way.
Even though libnet.h is always regenerated by configure, having it around still has some benefits (with respect to documentation) - Docs can be created independently from building (by running doxygen doc/libnet.doxygen.conf) - Docs can be hosted from within the repo (via codedocs.xyz)
yet another attempt to come after Travis build error by updating autoconf and libnet before building
a4wide? you kidding me?
- the include directory wasn't a fully qualified path - replaced hard-coded shebang - added --prefix option - added man page notice - added executable permissions
Just like all other ethertypes. Sitting there without it was what was causing the boatloads of macro redefinition warnings (see commit 64d27b and eb76d2) I should have though of that earlier...
It has been modified for libnet and should therefore always take precedence over the one shipped with the autoconf-archive (or bad things will happen)
Among many many other tiny changes: - updated to Doxygen 1.8.14 - stripped Doxyfile from all comments - HTML: Disabled every option that would require javascript - HTML: Custom Header and Footer (because me noo like javascript) - HTML: Custom CSS stylesheet (because libnet got style) - HTML: Change HTML output folder to "api" (because it's not like they're talking about anything else) - Enabled WARN_IF_UNDOCUMENTED (because everything should be documented) - Exclude headers that Doxygen can't understand (yet) or that don't say anything meaningful anyways (work in progress) - Tuned the Preprocessor (work in progress) - Tuned dot tool output - Added "standalone" version to libnet's root directory (mostly for CodeDocs.xyz)
if none is specified of course
This, among other things, translates to: - deleting the useless and misleading man page for libnet.h generated by Doxygen - adding two new "handcrafted" man pages: libnet and libnet-config - removing all underscore prefixed items - renaming .h.3-suffixes to simply .3 - Changing the internal name of the man pages to all UPPERCASE - Adjusting version string - Changing the title - Removing both the path and the ".h" extension from internal name - adding a few more sections (Author, See also, Bugs, and Copyright) to the end of all man pages generated by Doxygen - Adding a shell script that performs all above mentioned steps (and more) during build. Long live (GNU) sed...
it terrible but at least it's there
- added a doxygen specific ifndef around the messy include block to exclude them from the the docs. (See doc/TODO: "Prune the include list in libnet.h.in...") - replace main page section with "details" about libnet.h. leeel - added indication that libnet.h is created from libnet.h.in - rearranged includes - on windows , stdint.h in now only searched and included from standard include directories. Adding /Iwin32 to MYCOMPILE in the batch file later on should be enough for cl to get the message. - removed empty #if !(__linux__) && !(__WIN32__) && !(__APPLE__) &&... block from 5d63956
not sure why it had been...
Makefile.am got pretty crowded. I should divide it into sections...
forgot someone
api docs are published via codedocs from now on
sgeto
force-pushed
the
master
branch
3 times, most recently
from
396ea19 to
124cd4d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO:
make uninstalltarget