blob: c3cab787bc618bbcd567806ec51eb37b24bec029 [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 keystore}
/***/
{template .soyweb}
{call buck.page}
{param title: 'keystore()' /}
{param navid: 'rule_keystore' /}
{param prettify: true /}
{param description}
A rule that is used to define the important data for a key pair created
by the keytool executable.
{/param}
{param content}
{call buck.rule}
{param status: 'FROZEN' /}
{param overview}
A <code>keystore()</code> contains the data for a key pair
created by the <code>keytool</code> executable that comes
with the JDK. This is a required input for an {call buck.android_binary /} rule.
{/param}
{param args}
{call buck.name_arg /}
{call buck.arg}
{param name: 'store' /}
{param desc}
The path to the file that contains the key.
This is the path that was passed as the <code>-keystore</code> argument
when you ran <code>keytool</code>.
{/param}
{/call}
{call buck.arg}
{param name: 'properties' /}
{param desc}
The path to the <code>.properties</code> file that contains the following values:
{literal}<pre class="prettyprint lang-py">
# The value that you passed as the argument to -alias
# when you ran keytool.
key.alias=my_alias
# The value that you entered in response to
# the "Enter keystore password:" prompt.
key.store.password=store_password
# The value that you entered in response to
# the "Enter key password for &lt;my_alias>" prompt.
key.alias.password=alias_password</pre>{/literal}
{/param}
{/call}
{/param} // close args
{/call} // close buck.rule
{/param}
{/call}
{/template}