Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
kianmeng committed Mar 16, 2022
1 parent f5b114d commit 1b39279
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ If you find this project useful, and help it to be maintained, please donate to:

## When using it ? ##

- Each time you prepare a project release or update a dependancy.
- When you plan to add a dependancy to your project
- Each time you prepare a project release or update a dependency.
- When you plan to add a dependency to your project
- When writing your README, to inform your project's users on possible release window
- To limit test of CI tools on only possible release window

## Plugins ##

``geas`` is available as a [module](https://github.com/crownedgrouse/geas/wiki/Module-API), but you will probably prefere to use geas plugins with your usual build tool.
``geas`` is available as a [module](https://github.com/crownedgrouse/geas/wiki/Module-API), but you will probably prefer to use geas plugins with your usual build tool.

Plugin is available for [`erlang.mk`](https://github.com/crownedgrouse/geas/wiki/Erlang.mk-plugin) and [`rebar`](https://github.com/crownedgrouse/geas/wiki/Rebar-plugins) .

Expand Down Expand Up @@ -96,7 +96,7 @@ R16B03 ssh_message:encode_host_key/1
Current (C) Erlang release found is `23.4` and no patches (P) was detected.
The global project can run starting R16B03 up to 18.1 in such case, due to use of a function introduced in R16B03 and another one removed in 18.2.
Native x86 compilation was detected on test module.
Recommended patches (R) is optionally proposed when an application used in code is referenced in a not installed patche, even if in this exemple, current Erlang release cannot run the project.
Recommended patches (R) is optionally proposed when an application used in code is referenced in a not installed patche, even if in this example, current Erlang release cannot run the project.

## Tuning output ##

Expand All @@ -120,7 +120,7 @@ Environment variables cheatsheet :
`GEAS_HTTP_OPTS` | `string` | `httpc` options | Erlang term string with a final dot | | 2.6 |


Under compat table output, some informations can be shown depending those environment variables and analyze result.
Under compat table output, some information can be shown depending those environment variables and analyze result.
A single capital letter is used as tag for each information.

- C = Current : Current Erlang major.minor release used (for example 20.2)
Expand Down
4 changes: 2 additions & 2 deletions src/geas_api.hrl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

-define(COMMON_DIR(Dir),
AppFile = get_app_file(Dir),
% Informations inventory
% Information inventory
{AppName, Version , Desc} = get_app_infos(AppFile),
AppType = get_app_type(AppFile, Dir),
Native = is_native(Dir),
Expand Down Expand Up @@ -392,7 +392,7 @@ compat(RootDir, print, Config) ->
[] -> ok ;
_ -> io:format("P : ~ts~n", [string:join(Patches, " ")])
end,
% Display Recommanded Erlang release if requested
% Display Recommended Erlang release if requested
case Conf#config.tips of
false -> ok ;
true -> Rec = get_recommanded_patches(Current),
Expand Down
2 changes: 1 addition & 1 deletion src/geas_beam.hrl
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ get_src_from_beam(File) ->
filename:join([SrcDir, Basename ++ ".erl"])
end.
%%-------------------------------------------------------------------------
%% @doc Beam opcode compatibity
%% @doc Beam opcode compatibility
%% @end
%%-------------------------------------------------------------------------
beam_opcode_compat(Beam) ->
Expand Down
2 changes: 1 addition & 1 deletion src/geas_config.hrl
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ get_config() ->
%% GEAS_MY_RELS string Erlang release list List possible releases ...
%% GEAS_EXC_RELS string Erlang release list Exclude some releases ...
%% GEAS_DISC_RELS boolean [0 / 1] Show discarded buggy Erlang releases ...
%% GEAS_LOG string Log level list Log informations ...
%% GEAS_LOG string Log level list Log information ...
%% GEAS_TIPS boolean [0 / 1] Give tips on patches to apply
%% GEAS_RANGE string
%% GEAS_FRAME string
Expand Down
2 changes: 1 addition & 1 deletion src/geas_db.erl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
%%% @author Eric Pailleau <[email protected]>
%%% @copyright 2015 crownedgrouse.com
%%% @doc
%%% Guess Erlang Applicaion Scattering
%%% Guess Erlang Application Scattering
%%% Database generation module
%%% @end
%%%
Expand Down
2 changes: 1 addition & 1 deletion src/geas_defs.hrl
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
% GEAS_MY_RELS string Erlang release list List possible releases ...
% GEAS_EXC_RELS string Erlang release list Exclude some releases ...
% GEAS_DISC_RELS boolean [0 / 1] Show discarded buggy Erlang releases ...
% GEAS_LOG string Log level list Log informations ...
% GEAS_LOG string Log level list Log information ...
% GEAS_TIPS boolean [0 / 1] Give tips on patches to apply

-record(config, {use_src = false
Expand Down
8 changes: 4 additions & 4 deletions src/geas_doc.erl
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ release_diff_yaml_files(F1, F2) ->
release_diff_yaml(AT, BT).

%%-------------------------------------------------------------------------
%% @doc Release difference from two Release informations
%% @doc Release difference from two Release information
%% @end
%%-------------------------------------------------------------------------
-spec release_diff(list(), list()) -> list().
Expand All @@ -152,15 +152,15 @@ release_diff(R1, R2) ->
].

%%-------------------------------------------------------------------------
%% @doc Release difference from two Release informations in YAML
%% @doc Release difference from two Release information in YAML
%% @end
%%-------------------------------------------------------------------------
-spec release_diff_yaml(list(), list()) -> ok.

release_diff_yaml(R1, R2) -> yamlize(release_diff(R1, R2)).

%%-------------------------------------------------------------------------
%% @doc Release difference from two Release informations in YAML file
%% @doc Release difference from two Release information in YAML file
%% @end
%%-------------------------------------------------------------------------
-spec release_diffs(yaml | term, list(), list(), list()) -> ok.
Expand All @@ -170,7 +170,7 @@ release_diffs(yaml, Rel1, Rel2, File) ->
yamlize(release_diff(Rel1, Rel2), Io),
file:close(Io), ok;
%%-------------------------------------------------------------------------
%% @doc Release difference from two Release informations in term file
%% @doc Release difference from two Release information in term file
%% @end
%%-------------------------------------------------------------------------
release_diffs(term, Rel1, Rel2, File) ->
Expand Down
2 changes: 1 addition & 1 deletion src/geas_otp_versions.hrl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
%%-------------------------------------------------------------------------
%% @doc Get {min, recommanded, max} Erlang version from compiler version
%% @doc Get {min, recommended, max} Erlang version from compiler version
%% Look into https://github.com/erlang/otp/blob/maint/lib/compiler/vsn.mk
%% @end
%%-------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/geas_patches.hrl
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ update_otp_table(S, Opts)
end.

%%-------------------------------------------------------------------------
%% @doc Get recommanded patches
%% @doc Get recommended patches
%% @end
%%-------------------------------------------------------------------------
get_recommanded_patches(Current) ->
Expand Down

0 comments on commit 1b39279

Please sign in to comment.