Incorrect argument names and counts in dtrace probes documentation. #4296

albert-github · 2023-01-05T12:54:46Z

Lines 26 to 32 in 2e4e9e2

    
              * Fired when a message is being sent to an actor 
        
              * @param scheduler is the active scheduler's index 
        
              * @param id the message id 
        
              * @param actor_from is the sending actor 
        
              * @param actor_to is the receiving actor 
        
              */ 
        
             probe actor__msg__push(int32_t scheduler_index, uint32_t id, uintptr_t actor_from, uintptr_t actor_to);

Not only in the above code part, but also in some other parts:

src/common/dtrace_probes.d:35: warning: argument 'scheduler' of command @param is not found in the argument list of actor__msg__pop(int32_t scheduler_index, uint32_t id, uintptr_t actor)
src/common/dtrace_probes.d:35: warning: argument 'actor_to' of command @param is not found in the argument list of actor__msg__pop(int32_t scheduler_index, uint32_t id, uintptr_t actor)
src/common/dtrace_probes.d:35: warning: The following parameters of actor__msg__pop(int32_t scheduler_index, uint32_t id, uintptr_t actor) are not documented:
  parameter 'scheduler_index'
  parameter 'actor'
src/common/dtrace_probes.d:26: warning: argument 'scheduler' of command @param is not found in the argument list of actor__msg__push(int32_t scheduler_index, uint32_t id, uintptr_t actor_from, uintptr_t actor_to)
src/common/dtrace_probes.d:26: warning: The following parameter of actor__msg__push(int32_t scheduler_index, uint32_t id, uintptr_t actor_from, uintptr_t actor_to) is not documented:
  parameter 'scheduler_index'
src/common/dtrace_probes.d:19: warning: The following parameter of actor__msg__run(uintptr_t scheduler, uintptr_t actor, uint32_t id) is not documented:
  parameter 'scheduler'
src/common/dtrace_probes.d:150: warning: The following parameter of heap__alloc(uintptr_t scheduler, unsigned long size) is not documented:
  parameter 'scheduler'
src/common/dtrace_probes.d:51: warning: argument 'thread_to' of command @param is not found in the argument list of thread__msg__pop(uint32_t id, uintptr_t thread)
src/common/dtrace_probes.d:51: warning: The following parameter of thread__msg__pop(uint32_t id, uintptr_t thread) is not documented:
  parameter 'thread'
src/libponyc/pkg/platformfuns.h:30: warning: argument 'out_is' of command @param is not found in the argument list of os_is_target(const char *attribute, bool release, bool *out_is_target, pass_opt_t *options)
src/libponyc/pkg/platformfuns.h:30: warning: The following parameters of os_is_target(const char *attribute, bool release, bool *out_is_target, pass_opt_t *options) are not documented:
  parameter 'attribute'
  parameter 'release'
  parameter 'out_is_target'
  parameter 'options'
src/libponyc/pkg/platformfuns.h:30: warning: argument 'out_is' of command @param is not found in the argument list of os_is_target(const char *attribute, bool release, bool *out_is_target, pass_opt_t *options)
src/libponyc/pkg/platformfuns.h:30: warning: The following parameters of os_is_target(const char *attribute, bool release, bool *out_is_target, pass_opt_t *options) are not documented:
  parameter 'attribute'
  parameter 'release'
  parameter 'out_is_target'
  parameter 'options'

The text was updated successfully, but these errors were encountered:

SeanTAllen · 2023-01-05T12:57:27Z

What is incorrect in the quoted actor__msg__push?

SeanTAllen · 2023-01-10T19:48:43Z

I am not an expert but I believe that the string after @param needs to match the name in the function definition below in order to avoid the warning. I also found 1 that has an incorrect number of @param as it is missing one.

albert-github · 2023-01-11T08:42:00Z

Indeed the names of the arguments have to match the first argument after the @param
I missed the previous comment (#4296 (comment)) about actor__msg__push and in the argument list it says scheduler_index and in the @param it is scheduler

@params

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions. While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information. This commit fixes all the issues I found and in the process closes the original issue. Fixes #4296

@params

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions. While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information. This commit fixes all the issues I found and in the process closes the original issue. Fixes #4296

@params

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions. While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information. This commit fixes all the issues I found and in the process closes the original issue. Fixes #4296

@params

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions. While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information. This commit fixes all the issues I found and in the process closes the original issue. Fixes #4296

@params

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions. While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information. This commit fixes all the issues I found and in the process closes the original issue. Fixes #4296

@params

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions. While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information. This commit fixes all the issues I found and in the process closes the original issue. Fixes #4296

ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Jan 5, 2023

jemc changed the title ~~Incorrect documentated arguments~~ Incorrect documented arguments in dtrace probes documentation. Jan 10, 2023

jemc changed the title ~~Incorrect documented arguments in dtrace probes documentation.~~ Incorrect argument names and counts in dtrace probes documentation. Jan 10, 2023

SeanTAllen added help wanted Extra attention is needed bug good first issue Good for newcomers and removed discuss during sync Should be discussed during an upcoming sync labels Jan 10, 2023

ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Jan 11, 2023

SeanTAllen removed the help wanted Extra attention is needed label Jan 13, 2023

SeanTAllen self-assigned this Jan 13, 2023

SeanTAllen mentioned this issue Jan 13, 2023

Update DTrace probes #4302

Merged

SeanTAllen closed this as completed in #4302 Jan 17, 2023

ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Jan 17, 2023

SeanTAllen removed the bug label Jan 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incorrect argument names and counts in dtrace probes documentation. #4296

Incorrect argument names and counts in dtrace probes documentation. #4296

albert-github commented Jan 5, 2023

SeanTAllen commented Jan 5, 2023

SeanTAllen commented Jan 10, 2023

albert-github commented Jan 11, 2023

Incorrect argument names and counts in dtrace probes documentation. #4296

Incorrect argument names and counts in dtrace probes documentation. #4296

Comments

albert-github commented Jan 5, 2023

SeanTAllen commented Jan 5, 2023

SeanTAllen commented Jan 10, 2023

albert-github commented Jan 11, 2023