Skip to content

Commit

Permalink
site publish by finaglehelper
Browse files Browse the repository at this point in the history
  • Loading branch information
finaglehelper committed May 3, 2024
1 parent 664f113 commit 3f36e33
Show file tree
Hide file tree
Showing 31 changed files with 6,094 additions and 4,830 deletions.
52 changes: 25 additions & 27 deletions CodeGenDep.html
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Dependencies of the generated code &#8212; Scrooge 22.7.0 documentation</title>
<link rel="stylesheet" href="_static/scrooge.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>Dependencies of the generated code &#8212; Scrooge 24.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/scrooge.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Generated Scala Code Usage" href="GeneratedCodeUsage.html" />
Expand All @@ -38,7 +37,8 @@ <h3>Navigation</h3>
<li class="right" >
<a href="Finagle.html" title="Finagle Integration"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Scrooge</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">Scrooge</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Dependencies of the generated code</a></li>
</ul>
</div>

Expand All @@ -47,51 +47,49 @@ <h3>Navigation</h3>
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="dependencies-of-the-generated-code">
<section id="dependencies-of-the-generated-code">
<h1>Dependencies of the generated code<a class="headerlink" href="#dependencies-of-the-generated-code" title="Permalink to this headline"></a></h1>
<p>The plain code generated by Scrooge depends on apache libthrift (version 0.10.0) and scrooge-core.
You’ll need to add the following dependencies to your project, if you use maven (other
build systems are similar)</p>
<div class="highlight-scala notranslate"><div class="highlight"><pre><span></span> <span class="o">&lt;</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">thrift</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">thrift</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">libthrift</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="o">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="p">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">scrooge</span><span class="o">-</span><span class="n">core</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">dependency</span><span class="o">&gt;</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">We recommend using Apache Thrift 0.10.0 to ensure compatibility with Scrooge generated code.</p>
<p class="admonition-title">Note</p>
<p>We recommend using Apache Thrift 0.10.0 to ensure compatibility with Scrooge generated code.</p>
</div>
<p>If you specify –finagle option, you need to have the following additional dependencies</p>
<div class="highlight-scala notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="o">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="p">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">util</span><span class="o">-</span><span class="n">core</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="o">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="p">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">finagle</span><span class="o">-</span><span class="n">core</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">dependency</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="o">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">com</span><span class="p">.</span><span class="n">twitter</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">finagle</span><span class="o">-</span><span class="n">thrift</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">dependency</span><span class="o">&gt;</span>
</pre></div>
</div>
</div>
</section>


<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/scrooge.png" alt="Logo"/>
</a></p><a href="index.html"><h3>Scrooge</h3></a>
<div class="sphinxsidebarwrapper"><a href="index.html"><h3>Scrooge</h3></a>
<p>
Scrooge is a general purpose thrift parser/generator
</p>
Expand Down
47 changes: 22 additions & 25 deletions CommandLine.html
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Command Line &#8212; Scrooge 22.7.0 documentation</title>
<link rel="stylesheet" href="_static/scrooge.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>Command Line &#8212; Scrooge 24.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/scrooge.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Finagle Integration" href="Finagle.html" />
Expand All @@ -38,7 +37,8 @@ <h3>Navigation</h3>
<li class="right" >
<a href="MVNPlugin.html" title="Maven Plugin"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Scrooge</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">Scrooge</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Command Line</a></li>
</ul>
</div>

Expand All @@ -47,7 +47,7 @@ <h3>Navigation</h3>
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="command-line">
<section id="command-line">
<h1>Command Line<a class="headerlink" href="#command-line" title="Permalink to this headline"></a></h1>
<p>Aside from integrating with SBT and maven, Scrooge can also be run directly
from the command line. One way to do so is to run the main files of the
Expand All @@ -62,7 +62,7 @@ <h1>Command Line<a class="headerlink" href="#command-line" title="Permalink to t
</div>
<p>Working off of the master branch will ensure that you’re using the latest
released version of Scrooge.</p>
<div class="section" id="scrooge-generator">
<section id="scrooge-generator">
<h2>scrooge-generator<a class="headerlink" href="#scrooge-generator" title="Permalink to this headline"></a></h2>
<p>The ‘scrooge-generator’ project is responsible for converting Thrift IDL
files into generated code. Running it from the command line requires
Expand Down Expand Up @@ -94,7 +94,6 @@ <h2>scrooge-generator<a class="headerlink" href="#scrooge-generator" title="Perm
-V, --version print version and quit
-v, --verbose log verbose messages about progress
-d, --dest &lt;path&gt; write generated code to a folder (default: .)
--import-path &lt;path&gt; [DEPRECATED] path(s) to search for included thrift files (may be used multiple times)
-i, --include-path &lt;path&gt; path(s) to search for included thrift files (may be used multiple times)
-n, --namespace-map &lt;oldname&gt;=&lt;newname&gt; map old namespace to new (may be used multiple times)
--default-java-namespace &lt;name&gt; Use &lt;name&gt; as default namespace if the thrift file doesn&#39;t define its own namespace. If this option is not specified either, then use &quot;thrift&quot; as default namespace
Expand All @@ -112,8 +111,8 @@ <h2>scrooge-generator<a class="headerlink" href="#scrooge-generator" title="Perm
&lt;files...&gt; thrift files to compile
</pre></div>
</div>
</div>
<div class="section" id="scrooge-linter">
</section>
<section id="scrooge-linter">
<h2>scrooge-linter<a class="headerlink" href="#scrooge-linter" title="Permalink to this headline"></a></h2>
<p>The ‘scrooge-linter’ project is responsible for verifying that a Thrift
IDL file complies with Scrooge’s understanding of the Thrift grammar. It
Expand Down Expand Up @@ -151,18 +150,16 @@ <h2>scrooge-linter<a class="headerlink" href="#scrooge-linter" title="Permalink
&lt;files...&gt; thrift files to compile
</pre></div>
</div>
</div>
</div>
</section>
</section>


<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/scrooge.png" alt="Logo"/>
</a></p><a href="index.html"><h3>Scrooge</h3></a>
<div class="sphinxsidebarwrapper"><a href="index.html"><h3>Scrooge</h3></a>
<p>
Scrooge is a general purpose thrift parser/generator
</p>
Expand Down
Loading

0 comments on commit 3f36e33

Please sign in to comment.