[SERVER-5307] Import man pages from the MongoDB Manual (new docs) into Server Created: 14/Mar/12  Updated: 11/Jul/16  Resolved: 15/Mar/13

Status: Closed
Project: Core Server
Component/s: Packaging
Affects Version/s: None
Fix Version/s: 2.4.0-rc3

Type: Task Priority: Minor - P4
Reporter: Sam Kleinman (Inactive) Assignee: Ernie Hershey
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
is duplicated by DOCS-460 man pages are out of date Closed
Backwards Compatibility: Fully Compatible
Participants:

 Description   

The Manual (formerly "the new docs") can and will generate man pages for all of the utilites (mongodump, mongo, mongorestore, et al) and other binaries (mongod and mongos) distributed with MongoDB. These man pages should be distributed with MongoDB for consistency and easy updating.

To generate these pages. Have Sphinx installed, clone the docs/ repo and run "make man". Alternately the "make build-man" will also gzip the man pages, if that's preferred.



 Comments   
Comment by auto [ 15/Mar/13 ]

Author:

{u'date': u'2013-03-15T00:06:31Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 fixing file mode to match other man page files
Branch: master
https://github.com/mongodb/mongo/commit/a9e3f501a75c36a462e8a360f418fbd35779af3d

Comment by auto [ 15/Mar/13 ]

Author:

{u'date': u'2013-03-15T00:03:28Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 fixing file mode to match other man page files
Branch: v2.4
https://github.com/mongodb/mongo/commit/eace82e9395abe0c92091adc255c05b1430e7a2f

Comment by auto [ 15/Mar/13 ]

Author:

{u'date': u'2013-03-14T23:10:58Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 Only include new man pages in rpm if version > 2.4.0
Branch: v2.4
https://github.com/mongodb/mongo/commit/a8fd67b31adb0bfd99967543b10c7dda4e8d614c

Comment by auto [ 15/Mar/13 ]

Author:

{u'date': u'2013-03-14T23:09:00Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 Include new man pages in rpm
Branch: v2.4
https://github.com/mongodb/mongo/commit/f89c7424fc8777ef43c0f3557515f1a0f1f9d91e

Comment by auto [ 15/Mar/13 ]

Author:

{u'date': u'2013-03-14T23:00:30Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 New man pages generated from docs by samk@10gen.com
Branch: v2.4
https://github.com/mongodb/mongo/commit/b894cc7211a5520196a735301a26a0df33123819

Comment by auto [ 14/Mar/13 ]

Author:

{u'date': u'2013-03-14T23:10:58Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 Only include new man pages in rpm if version > 2.4.0
Branch: master
https://github.com/mongodb/mongo/commit/9d5a7c8631e4fc9e7b4d7c9eee684d4f8029db20

Comment by auto [ 14/Mar/13 ]

Author:

{u'date': u'2013-03-14T23:09:00Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 Include new man pages in rpm
Branch: master
https://github.com/mongodb/mongo/commit/206cf27c5847ca2e44eba20d69904d92ae71c8db

Comment by auto [ 14/Mar/13 ]

Author:

{u'date': u'2013-03-14T23:00:30Z', u'name': u'Ernie Hershey', u'email': u'ernie.hershey@10gen.com'}

Message: SERVER-5307 New man pages generated from docs by samk@10gen.com
Branch: master
https://github.com/mongodb/mongo/commit/b4704b474f055d71ed2f92d2d241293736792f42

Generated at Thu Feb 08 03:08:30 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.