raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Fixes #13983

Browse source 
Two changes have been made:
- In AkkaBuild, forced using UTF-8 to verify HTML files containing
  diagrams
- In the documentation chapter Building Akka, added a section clarifying
  the Graphviz dependency of generating Scaladoc Content Hierarchies

These fixes eliminates the issues I faced while building Akka on Windows
with NetBeans. The first issue is a Windows specific issue where the
default charset cannot be UTF-8. The second is Windows related in the
sense that Graphviz, the optional dependency of Scaladoc, had to be
manually resolved.
This commit is contained in:
Csongor Somogyi 2014-04-15 11:40:51 +02:00
parent 6a111d5201
commit 9230f9710f
2 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
akka-docs/rst/dev/building-akka.rst
View file

@ -150,3 +150,13 @@ You can look at the Ivy dependency resolution information that is created on
the resolution information for the akka-remote module compile dependencies. If
you open this file in a web browser you will get an easy to navigate view of
dependencies.
Scaladoc Dependencies
=====================
The Scaladoc may generate Content (Type) Hierarchy diagrams. For this, you may
be required to download and install Graphviz (http://www.graphviz.org/).
The installed toolset has to be added to the PATH.
Without Graphviz, the project will be completely built but with error messages
regarding the absence of the diagram tool cumulated at the end.