System Docs Page example is wrong

Open
#2,037 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
lua
Domain
documentation

Research direction

Start at the System documentation page linked in the issue and compare the published Lua example with the reported working form. Update the example so its system filters use the documented system values and verify that the page no longer shows the error-producing usage.

Written by the indexing model from the issue text.

Description

The example in the docs page throws an error and is not the correct way to use system
The example given results in a error during any action:

workspace "MyWorkspace"
   configurations { "Debug", "Release" }
   system { "Windows", "Unix", "Mac" }

   filter "system:Windows"
      system "windows"

   filter "system:Unix"
      system "linux"

   filter "system:Mac"
      system "macosx"

Should be something more like this... (from what I can tell)

workspace "MyWorkspace"
   configurations { "Debug", "Release" }

   filter "system:windows"
      -- some items

   filter "system:linux"
      -- some items 

   filter "system:macosx"
      -- some items
Dominant language
C
Stars
3.6k
Forks
654
Avg merge
1d 1h
Merged PRs (30d)
13

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from premake/premake-core

All issues in premake/premake-core

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.