Skip to content

Commit

Permalink
Clarify docs about sources plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
gosar committed Feb 22, 2022
1 parent cb12934 commit b2911b2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/source/1.0/guides/building-models/build-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1446,14 +1446,15 @@ Smithy models contained within the JAR are copied as a source model while the
JAR itself is not copied. If there are no source models, an empty manifest is
created.

When applying a projection, a new model file is created that contains only
the shapes, trait definitions, and metadata that were defined in a source
model *and* all of the newly added shapes, traits, and metadata.
When building projections other than ``source``, a new model file is created
that contains only the shapes, trait definitions, and metadata that were
defined in a source model *and* all of the newly added shapes, traits, and
metadata.

The manifest file is a newline (``\n``) separated file that contains the
relative path from the manifest file to each model file created by the
sources plugin. Lines that start with a number sign (#) are comments and are
ignored. A Smithy manifest file is stored in a JAR as ``META-INF/smithy/manifest``.
All model names referenced by the manifest are relative to ``META-INF/smithy/``.
All model files referenced by the manifest are relative to ``META-INF/smithy/``.

.. _Java SPI: https://docs.oracle.com/javase/tutorial/sound/SPI-intro.html

0 comments on commit b2911b2

Please sign in to comment.