Unverified Commit 2daf0e45 authored by Mark Vander Stel's avatar Mark Vander Stel
Browse files

Update CHANGELOG and release notes for v2.0.0-rc.1

parent b7b675ad
This diff is collapsed.
......@@ -216,3 +216,7 @@ Thanks again to everyone for all of the help and support!
* Otto Kekäläinen (@ottok)
* Mike Simonson (@mikeSimonson)
* Viorel-Cosmin Miron (@uhlhosting)
* Dimitrie Hoekstra (@dimitrieh)
* Hynek Vychodil (@pichi)
* Ned Batchelder (@nedbat)
* Gary Wolfman (@OldCrow)
......@@ -36,6 +36,16 @@ To power the themes, all of the data sources in Liquidprompt have been broken
out into individual data functions that can be called by themes. They are also
documented in detail in :doc:`../functions/data`.
Path Advanced Formatting
========================
The current directory path has had an overhaul, now supporting formatting for
different path sections, highlighting the last directory and the VCS repository
root directory. Any shortened directories are lowlighted instead. Multiple path
shortening methods are now supported as well.
See :attr:`LP_PATH_METHOD` and :attr:`LP_COLOR_PATH` for more information.
Version Control Interface
=========================
......@@ -72,3 +82,16 @@ Documentation
The often lacking README documentation has been re-written with Sphinx to make
this much improved documentation source.
Unit Tests
==========
A whole suite of unit tests has been added to test the data and untility
functions. A handful of bugs were caught using the tests, so the investment has
already paid off!
Dirstack Feature
================
Shell directory stack display is now in the prompt! If there are directories on
the stack (from ``pushd``), the number of directories in the stack is shown next
to the current path. See :attr:`LP_ENABLE_DIRSTACK` for more information.
Version 2.0 Upgrade Notes
*************************
Most of the changes in 2.0 are in private functions and variables.
There are three public API changes that could impact users:
:ref:`$lp_err <lp_err>`, :ref:`$LP_DISABLED_VCS_PATH <lp_disabled_vcs_path>`,
and :ref:`_lp_title() <lp_title>`.
The rest are private API changes, but are still documented here.
Most of the changes in 2.0 are in private functions and variables. There are a
few public API changes that could impact users: :ref:`$lp_err <lp_err>`,
:ref:`$LP_DISABLED_VCS_PATH <lp_disabled_vcs_path>`, :ref:`$LP_PATH_DEFAULT
<lp_path_default>`, :ref:`$PROMPT_DIRTRIM <prompt_dirtrim>`,
:ref:`$LP_PATH_KEEP=-1 <lp_path_keep>`, and :ref:`_lp_title() <lp_title>`. The
rest are private API changes, but are still documented here.
.. contents::
:local:
......@@ -416,11 +417,7 @@ Recommended to not use this internal function.
_lp_shorten_path()
------------------
Renamed to :func:`__lp_shorten_path`.
Recommended that :attr:`lp_path` is used instead.
Return changed from stdout to ``$lp_shorten_path``
Removed and replaced by :func:`_lp_path_format`.
Replace assignment statements like::
......@@ -428,9 +425,9 @@ Replace assignment statements like::
with::
local lp_shorten_path
__lp_shorten_path
cwd=$lp_shorten_path
local lp_path_format
_lp_path_format "$LP_COLOR_PATH" "$LP_COLOR_PATH_LAST_DIR" "$LP_COLOR_PATH_VCS_ROOT" "$LP_COLOR_PATH_SHORTENED" "/" "$LP_COLOR_PATH_SEPARATOR"
cwd=$lp_path_format
_lp_smart_mark()
----------------
......@@ -622,6 +619,32 @@ with::
LP_DISABLED_VCS_PATHS=("/my/one/path" "/my/other/path")
.. _lp_path_default:
$LP_PATH_DEFAULT
----------------
Replaced by :attr:`LP_PATH_METHOD`.
If one of the many new shortening methods does not effectively replace your use
case, please open an enhancement request.
.. _prompt_dirtrim:
$PROMPT_DIRTRIM
---------------
``$PROMPT_DIRTRIM`` calculation is no longer supported. Replaced by
:attr:`LP_PATH_METHOD` set to ``truncate_chars_from_path_left``.
.. _lp_path_keep:
$LP_PATH_KEEP=-1
----------------
:attr:`LP_PATH_KEEP` set to ``-1`` is replaced by :attr:`LP_PATH_METHOD` set to
``truncate_to_last_dir``.
.. _lp_title:
_lp_title()
......@@ -658,11 +681,11 @@ If the function returns a more complicated return code, you can store it like
this::
_lp_user
local -i code=$?
local -i code="$?"
or like this if the code only matters if it is not zero::
_lp_user || local -i code=$?
_lp_user || local -i code="$?"
_lp_sb()
--------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment