search

cpp-netlib / cpp-netlib

The C++ Network Library Project -- cross-platform, standards compliant networking library.
http://cpp-netlib.org/
Boost Software License 1.0
1.99k stars 425 forks source link

Incomplete documentation / examples for MIME lib #316

Open infinity0 opened 10 years ago

infinity0 commented 10 years ago

I know you probably already know this, but I am documenting this in case anyone else gets confused. Also, it means I have to leave this out of the Debian package I'm making, so ping me when it is complete so I can put it in properly.

The Jamfiles don't work (as far as I can see - totally a bjam noob):

libs/mime/doc$ bjam 
../../../Jamroot:11: in modules.load
*** argument error
* rule use-project ( id : where )
* called with: ( /boost :  )
* missing argument where
/usr/share/boost-build/build/project.jam:1138:see definition of rule 'use-project' being called
/usr/share/boost-build/build/project.jam:311: in load-jamfile
/usr/share/boost-build/build/project.jam:64: in load
/usr/share/boost-build/build/project.jam:113: in load-parent
/usr/share/boost-build/build/project.jam:449: in initialize
/usr/share/boost-build/build/project.jam:301: in load-jamfile
/usr/share/boost-build/build/project.jam:64: in load
/usr/share/boost-build/build/project.jam:145: in project.find
/usr/share/boost-build/build-system.jam:535: in load
/usr/share/boost-build/kernel/modules.jam:289: in import
/usr/share/boost-build/kernel/bootstrap.jam:139: in boost-build
/usr/share/boost-build/boost-build.jam:8: in module scope

Same result for libs/mime/examples.

The documentation also appears to be incomplete; building with quickbook gives many "Unable to read file" errors.

infinity0 commented 10 years ago

Tagging @mclow.

Since the main build system is cmake you should probably just get rid of the Jamfiles and use CMakeLists.txt instead - see #299.

deanberris commented 10 years ago

I'm removing the Jamfiles from the project now. I don't think @mclow will have time to do this in time for the 0.11 release (which I'm working on releasing within the week).

deanberris commented 10 years ago

I don't know about the documentation though, we're probably going to have to find some time later on to migrate the documentation from quickbook to ReST/Sphinx but that's going to have to happen for later.