jakartaee / jakartaee/faces

11.4.3.3 (Packaging Flows in Directories) ambiguity

Open
#1,371 6 comments 0 reactions 0 assignees View on GitHub
Component: Flow Priority: Major Type: Bug
Dominant language
Java
Stars
127
Forks
59
Avg merge
23h
Merged PRs (30d)
7

Description

SH> The relevant spec is JSF 2.2 11.4.3.3 (Packaging Flows in Directories): there it says "The following conventions apply to
SH> flows defined in this manner. Any flow definition in the
SH> corresponding -flow.xml
SH> file will override any of the conventions in the case of a conflict.
SH> Every vdl file in that directory is a view node of that flow.
SH> The start node of the flow is the view whose name is the same as the name of the flow.
SH> ..."
SH> (note the ambiguity - "Every vdl file in that directory" ... which directory?)

EB> "that directory" is the directory containing the corresponding
EB> -flow.xml file. For example, in the case of the following
EB> convention match, "bounded-task-flow/bounded-task-flow-flow.xml",
EB> "that directory" is "bounded-task-flow/".
#### Affected Versions
[2.2]

Contributor guide

Open the contributing guide

Research direction

Start by reading JSF 2.2 section 11.4.3.3, especially the sentence containing “Every vdl file in that directory.” Confirm where the specification text is maintained, then clarify that the directory is the one containing the corresponding -flow.xml file; done means the ambiguity is removed and the example remains consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.