Nim: Document all -d:flags of compiler

Created on 24 Sep 2019  路  6Comments  路  Source: nim-lang/Nim

Some are mentioned on the Manual, but is not complete, needs descriptions and info:

  • -d:quick :arrow_right: ???, still works?, is Deprecated?, not documented.
  • -d:useStdoutAsStdmsg :arrow_right: Use Std Out as Std Msg?, This is for Windows or Linux?, not documented on manual.
  • -d:nimOldShiftRight :arrow_right: http://forum.nim-lang.org/t/4891#30600 ?, but not documented on manual.
  • -d:nimOldCaseObjects :arrow_right: Old case switch?, still works?, not documented.
  • I am missing some flag?.

Should be easy, I dont send PR because I am not sure of all of them.
:slightly_smiling_face:

Documentation

All 6 comments

Covered here: https://nim-lang.org/docs/nimc.html#additional-compilation-switches

But probably miss a few.

You are right, is covered there, but few are missing, mostly new ones, I mentioned the ones I found.
:slightly_smiling_face:

I can pick this up, but I could use some hints how to approach this. The list of all defines checked for in /lib is quite extensive: list.txt

How do we know which are generated, which are relevant, which are obsolete, which are essential?

What's the point in documenting them? Most are implementation details. The "nimc" document covers what should be covered.

Because people may read about these options and be confused about their use. Even documenting them as "do not use" would be useful

Being confused when reading Nim's implementation doesn't mean the official documentation should mention it. By the same logic we could document c: PContext in the nimc document. Makes no sense. If you want to clean up the implementation and add documentation to it, be my guest but neither nimc.rst nor manual.rst are the right places.

Was this page helpful?
0 / 5 - 0 ratings