[DOCS-13020] Standardize Windows incompatibility mongod cli options documentation Created: 06/Sep/19  Updated: 30/Oct/23

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Minor - P4
Reporter: Nathan Contino (Inactive) Assignee: Nathan Contino (Inactive)
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 14 weeks, 2 days ago
Story Points: 2

 Description   

Description

Some of the mongod command line options are incompatibile with windows – for instance, --fork, --syslog, --nounixsocket, --unixSocketPrefix, --filePermissions.

Notably, fork/syslog explicitly state that they are not compatible with Windows. nounixsocket, unixSocketPrefix, and filePermissions only state that they are only available on Unix systems. Since syslog and fork are Unix paradigms, it might make sense to consolidate on this wording instead of mentioning Windows specifically (though the exact wording might depend on audience – some Windows users might not intuitively understand that it is not a Unix system, especially given WSL enhancements as of late).

We need to:
1) Identify all mongod cli options that are incompatible with Windows
2) Create a standardized, externally defined include file wording to replace the current incompatibility notices
3) Replace/Insert the standardized wording for each Windows-incompatible cli option.

Scope of changes

https://docs.mongodb.com/manual/reference/program/mongod/index.html
Specifically:
https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-syslog

https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-syslogfacility

https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-nounixsocket

https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-unixsocketprefix

https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-filepermissions

https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-fork

https://docs.mongodb.com/manual/reference/program/mongod/index.html#cmdoption-mongod-shutdown

 

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Education Bot [ 31/Oct/22 ]

Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!

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