Opened 14 years ago
Closed 12 years ago
#1937 closed Tasks (fixed)
Boost.Filesystem documentation and tutorial needs
Reported by: | Beman Dawes | Owned by: | Beman Dawes |
---|---|---|---|
Milestone: | Boost 1.36.0 | Component: | filesystem |
Version: | Boost 1.35.0 | Severity: | Problem |
Keywords: | Cc: |
Description
The documentation for Boost.Filesystem uses the phrase "implementation defined" in at least one place without subsequently defining whatever it is (see the pathname grammar). Since these docs have to describe a particular implementation and not just be a prototype for standardization, don't we need to fill in the details?
I also wonder if adhering to the standard documentation form for reference materials really makes this library accessible enough for general use. Even understanding the first example program ("simple ls") requires me to read through a great deal of reference material to understand what's going on. Maybe that just means a more complete tutorial is needed?
-- Dave Abrahams BoostPro Computing http://www.boostpro.com
A completely new tutorial has been written for Boost.Filesystem Version 3, which will ship with Boost release 1.44.
Thanks,
--Beman