search

premake / premake-core

Premake
https://premake.github.io/
BSD 3-Clause "New" or "Revised" License
3.2k stars 618 forks source link

Deprecation language in docs is not clear. #2222

Open JSandusky opened 2 months ago

JSandusky commented 2 months ago

What are you trying to do? Documentation description of intent to later deprecate is ambiguous.

Docs read: x64: Alias for x86_64; There is intent to deprecate this

Which one? x64 alias will be deprecated or the x86_64 specifier will be deprecated and x64 will take its' place?

samsinsane commented 2 months ago

Are you referring to the architecture docs?

value is one of:

  • [...]
  • x86
  • x86_64
  • [...]

Additional values that are aliases for the above:

  • [...]
  • x32: Alias for x86; There is intent to deprecate this
  • x64: Alias for x86_64; There is intent to deprecate this

I'm not sure I agree about the ambiguity - if we intended to deprecate x86 or x86_64 those lines would contain the deprecation notice not the x32 and x64 lines. However, I think the action to be taken here is to just remove the deprecation comments until the deprecation actually occurs.