Odin icon indicating copy to clipboard operation
Odin copied to clipboard

odin doc odin/core/runtime fails

Open thePHTest opened this issue 3 years ago • 3 comments
trafficstars

Context

Running odin doc explicitly on the runtime directory fails

  • Operating System & Odin Version: Odin: dev-2022-01:686dbb44 OS: Windows 10 Home Basic (version: 20H2), build 19042.1466 CPU: Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz RAM: 8055 MiB

Expected Behavior

It outputs the doc information for the runtime package. Currently there is a workaround by doing odin doc core -all-packages

Current Behavior

C:\odin\core\runtime (master -> origin) λ odin doc . C:/odin/core/runtime/udivmod128.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/procs_windows_amd64.odin(2:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/procs.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/print.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/os_specific_windows.odin(3:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/os_specific_any.odin(2:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/os_specific.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/entry_windows.odin(3:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/error_checks.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/entry_wasm.odin(3:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/internal.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/dynamic_array_internal.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/entry_unix.odin(3:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/dynamic_map_internal.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/default_temporary_allocator.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/default_allocators_windows.odin(2:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/default_allocators_nil.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/default_allocators_general.odin(5:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/core_builtin_matrix.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/core_builtin_soa.odin(1:10) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/core.odin(21:9) Syntax Error: Use of reserved package name 'runtime' C:/odin/core/runtime/core_builtin.odin(1:10) Syntax Error: Use of reserved package name 'runtime'

Failure Information (for bugs)

Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.

Steps to Reproduce

odin doc core/runtime

thePHTest avatar Jan 17 '22 21:01 thePHTest

Strangely, running odin doc core/runtime from the root odin directory results in no output. From all other locations, the above error output is the result.

thePHTest avatar Jan 17 '22 21:01 thePHTest

I think fixing this issue will improve OLS as go-to-definition is often broken for stuff in runtime. The same error output above occurs with odin check runtime

thePHTest avatar Jan 17 '22 23:01 thePHTest

Hello!

I am marking this issue as stale as it has not received any engagement from the community or maintainers 120 days. That does not imply that the issue has no merit! If you feel strongly about this issue

  • open a PR referencing and resolving the issue;
  • leave a comment on it and discuss ideas how you could contribute towards resolving it;
  • leave a comment and describe in detail why this issue is critical for your use case;
  • open a new issue with updated details and a plan on resolving the issue.

The motivation for this automation is to help prioritize issues in the backlog and not ignore, reject, or belittle anyone..

github-actions[bot] avatar Jul 24 '22 22:07 github-actions[bot]