Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-13020

Standardize Windows incompatibility mongod cli options documentation

    • Type: Icon: Task Task
    • Resolution: Won't Do
    • Priority: Icon: Minor - P4 Minor - P4
    • Server_Docs_20231030
    • Affects Version/s: None
    • Component/s: manual
    • Labels:
      None
    • 2

      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.)

            Assignee:
            nathan.contino@mongodb.com Nathan Contino (Inactive)
            Reporter:
            nathan.contino@mongodb.com Nathan Contino (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              1 year, 24 weeks, 4 days ago