Skip to content

Commit

Permalink
Finish add Commit ID explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
Thibault Gouala committed Feb 22, 2018
1 parent 45631bc commit 0c641ed
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 15 deletions.
3 changes: 2 additions & 1 deletion sphinx/source/general/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Here a list of the core features :
* Provides a list of unused assets for each builds.
* Provide the possibility to share build reports on a VCS, or to save it in different location for each team member.
* Possibility to run build generation silently or to totally shut it off.
* Very responsive UI, even for projects with a large list of assets, thanks to the usage of `.Guacamole <https://github.com/ArtOfSettling/.Guacamole>`_, an open source MVVM framework for Unity.
* Very responsive UI, even for projects with a large amount of assets, thanks to the usage of `.Guacamole <https://github.com/ArtOfSettling/.Guacamole>`_,
an open source MVVM framework for Unity.

About the documentation
-----------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ These two panels give you a detailed list of the assets included or not in your
.. image:: images/build-report-assets/assets.png

Assets Information
-----------------
------------------

The **Total Size** on top of the list is the sum of all the assets *Imported Size*.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Build Duration
programmatically change these settings, see XXXXXXXXX

Commit Id
If your Unity project is linked to a VCS repository, then the commit id at build time will be saved and display here. Note that .Peek supports
only GIT at the moment.
If your Unity project is linked to a VCS repository, then the commit id at build time will be saved and display here. Note
that .Peek supports only GIT and SVN at the moment. Windows users may need to ensure these VCS are installed on the command line.

Platform
The platform the build was done for. For the moment .Peek support generating build reports only for MacOS, Linux, Windows, Android and iOS.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _doc_ui-overview_build-report-settings:


Build Settings
==============
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 21 additions & 10 deletions sphinx/source/ui-overview/settings-page.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Settings
========

The settings page is accessible from the **Settings** button on the top of .Peek window. Some settings are personal settings,
which means they are saved in the folder *[Unity Project]/.wellfired* which should be ignored from your VCS. Some settings are
team shared and are saved in *[Unity Project]/WellFired* which should be added to your VCS repository.
which means they are saved in the folder *[Unity Project]/.wellfired* which should be ignored from your VCS. Some settings are team shared and are saved in *[Unity Project]/WellFired* which should be added to your VCS
repository, they are marked with |team|.

.. tip:: Note that these settings can be controlled
programmatically if you want to enforce .Peek behaviour on different computers (for Continuous Integration for example).
Expand All @@ -21,13 +21,24 @@ Automatically open
This is a personal setting.

Build reports location
This is the location where reports are saved. You can indicate either an absolute path, or a relative path. Relative paths root folder
is your Unity project folder (the one containing Assets/ folder). Different Unity project can save their reports in the same
folder. Indeed, .Peek will create a subfolder with the GUID it assigned to your Unity project. The GUID is a team shared
setting saved in *[Unity Project]/WellFired*.
This is the location where reports are saved.

Relative paths are team shared. Therefore, if you input *"../BuildReports"* as report location, then all of your
team members will have their build reports saved in *[Unity Project]/../BuildReports*.
* |team| Relative paths are team shared. Therefore, if you input *"../BuildReports"* as report location, then all of your
team members will have their build reports saved in *[Unity Project]/../BuildReports*.

If the path is an absolute one, then it will not affect other team members reports location.
Note that if you indicate a location inside the Unity project, it will be automatically converted to a relative location.
* Absolute path are personal, then it will not affect other team members reports location.
Note that if you indicate a location inside the Unity project, it will be automatically converted to a relative location.

.. tip:: Different Unity project can save their reports in the same folder. Indeed, .Peek will create a subfolder with
the GUID it assigned to your Unity project. The GUID is a team shared setting.

Track VCS version |team|
If enable and SVN or GIT is installed on your computer, the version of the commit you are building will appear in the report.

If your workspace differed with the VCS version, then *-unsync* will be added to the version (such as : **Commit Id** *4baa424-unsync*).

Windows users may need to ensure these VCS are installed on the command line. Computers not supporting it will simply display
**Commit Id** *unknow* no matter this option is enabled or not.

.. |team| image:: images/settings-page/team.png
:align: bottom

0 comments on commit 0c641ed

Please sign in to comment.