blob: 3cb7a7905239e1786c9ebf2d9bc647eeeeaf5f57 [file] [log] [blame]
/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
{namespace buck.core_data_model}
/***/
{template .soyweb}
{call buck.page}
{param title: 'core_data_model()' /}
{param navid: 'rule_core_data_model' /}
{param prettify: true /}
{param description}
A rule that is used to represent Core Data models (Apple platforms only).
{/param}
{param content}
{call buck.rule}
{param status: 'UNFROZEN' /}
{param overview}
An <code>core_data_model()</code> rule contains models for Apple's Core Data framework. This rule does not have any output on its own and can be built only as a dependency
(either direct or transitive) of an <a href="{ROOT}rule/apple_bundle.html">
<code>apple_bundle()</code> rule</a>, in which case all <code>core_data_model()</code> rules
that the bundle rule depends on are merged and placed into the final output bundle together.
{/param}
{param args}
{call buck.name_arg /}
{call buck.arg}
{param name: 'path' /}
{param desc}
Relative path of the .xcdatamodeld package directory.
{/param}
{/call}
{/param} // args
{param examples}
{literal}<pre class="prettyprint lang-py">
core_data_model(
name = 'MyCoreDataModel',
path = 'MyCoreDataModel.xcdatamodeld',
)
</pre>{/literal}
{/param} // examples
{/call} // buck.rule
{/param}
{/call}
{/template}